组织是否需要技术文档样式指南?

组织是否需要技术文档样式指南? 这个问题在在线论坛上经常出现。 当今日益紧张的工作场所预算也应引起人们对技术文档样式指南的关注。 我对样式指南问题的回答是:“是的,组织确实需要样式指南,但它不应支配文档开发生命周期。” 随着在线文档和网络提供信息的普及以及更多的迭代开发和发布周期,样式指南应提高生产力和一致性,而不是阻碍技术编写者和培训开发人员制定截止日期的障碍。 我的风格指南概念 多年来,我已经成为更精益风格指南的粉丝。 涵盖产品命名,公司品牌和任何行业/受众特定的基础知识,并在此保留样式指南。 文档应采用快速参考格式,在放宽技术写作项目之前,应向所有文档作者简要介绍样式指南。 当然,有很多事情可能会导致这种样式指南的方法遗漏,但这就是行业样式指南(例如《 Microsoft技术出版物样式手册》或《 ReadMe First!》)标准化的地方。 有关样式的决策 关于风格问题的犹豫不决的决策是粗鲁的,适得其反,最终,对文档,项目或最终客户没有好处。 使用精简的样式指南意味着在动态做出风格决定时可能会出现这种情况。 仅当高级作家或编辑者拥有对样式决策的所有权时,此方法才有效。 任何样式决定都必须记录在样式指南更新中。…

在陌生的土地上:第1部分

当我回到阿贝库塔伊塔-埃莱加的家时,情况完全不同。 自从我哥哥从学校接我起,我就只字未提。 最近两个小时,我在父亲父亲的车尾哭泣。 我的姐姐,家中的长子阿比(Abi)在我穿过大门进入前门时拥抱了我。 她不知道我没有朝她跑,我正在逃跑。 远离她,远离我自己,远离FGGC遗留下来的死者*,我没有抱住她的后背,相反,我忍住了眼泪,让我的手臂跌落在我身旁。 她吻了我,欢迎我回家。 她将胳膊放在我的肩膀上,带我进入房子,经过我们的第一个客厅和厨房,再回到我父亲坐在的第二个客厅,他的眼镜glasses地放在鼻子上。 他抬头看着我微笑。 “欢迎回家,Ayo,学校一年级了?”我的眼睛流水了,我的喉咙被粘在了一起,阻塞了空气和言语的通过。 我父亲问道:“安安,千古阿约?” [1] 当我努力地说出话时,我的妹妹在客厅的拱门下跑来跑去,通往我父母的卧室和我们的卧室。 Iyanu睁开双臂,看着亲密的象牙,露出灿烂的象牙微笑,向我跑去,紧紧地拥抱着我。 她的怀抱是我不加思索或毫无保留地回报的。 在她的怀抱中,我开始哭泣。 伊亚努(Iyanu)无法辨别我的眼泪是喜悦还是悲伤,问我是快乐还是沮丧。 父亲走过去,把我举到肩膀上,用爱轻轻地摇了摇我,他的瓷器牙齿骄傲地在新月形的嘴里微笑。…