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