我工作的组织正在成长,随着成长而来的是成熟,而随着成熟而来的是更好地记录的需求。
如今,目录、维基、OneNotes 杂乱无章,而且在形式或内容、标签甚至在何处查找项目方面都缺乏标准化。每个团队都各不相同,甚至团队中的个人也不一定遵守任何团队标准。
我并不是在寻找具体的产品或关于标准化的建议。我更感兴趣的是大型组织/企业正在使用什么标准。
答案1
技术文档 ISO 标准有很多,如所列zh.wikipedia.org/wiki/Technical_documentation。维基百科文章暗示这些是特定于某些行业的(据我所知,实际的 ISO 标准在公共领域不容易获得)...
例如软件开发IEEE 12207还管理文档。
但内部文档的整个问题是,大多数组织往往想做任何对他们有用的事情,而不是遵循外部标准。
在尝试执行标准之前,如果并且当满足以下条件时,您已经领先一步了:
- 文档实际上生成
- 需要的人可以获得文档(需要时可以搜索并找到它,然后也可以访问......)
- 文档得到维护并且是最新的
作为 IT 部门,无需尝试创建和/或执行任何特定标准,只需提供便利,例如提供良好的内部搜索引擎
答案2
我不知道任何行业标准,但我在内部文档方面最好的经验是在一个拥有专门的团队负责支持和策划文档基础设施。但他们不是负责自己编写所有文档。
他们使用的系统恰好是 wiki,但任何单一事实来源都应该有效。我甚至会说它应该原生支持版本控制。我最不能忍受的就是人们通过电子邮件传递 Word 文档,其中有多个页面专门用于文档更改日志。如果您需要当前修订版的副本,那么从源导出为 PDF 应该很容易。
团队中的大多数成员都有技术写作背景。他们负责开发常见文档类型的模板。他们会帮助其他团队开始编写自己的文档。他们会审核人们正在创建的文档,并可能对其进行编辑以确保其风格/一致性。这真是太棒了。
老实说,编写好的文档需要时间和精力。没有什么神奇的工具可以让这一切变得简单。特定系统的 SME 必须愿意为其各种系统/项目编写(并保持更新)文档。
答案3
我不能代表特别大的组织发言,但对于大多数规模的组织来说,制定一个组织良好的标准并(在合理范围内)执行它,以便所有这些文档都在一个平台上,最好是一个具有访问控制和搜索功能的平台,这是一个巨大的进步。
就合法标准和标准实践而言,我发现这 详细说明如何开发自己的标准,以及可能需要考虑哪些因素,以及引用相关的 ISO 标准。
我相信就定义的标准而言这就是全部了,因此接下来只需创建适合您组织需求的标准。