内部文档行业标准？

Question

我为之工作的组织是一个成长中的组织，伴随着成长而来的是成熟，伴随着成熟就需要更好的文档。

今天，它是一个目录，wiki，OneNotes的霍奇波奇，没有一个是标准化的形式或内容，标签，甚至知道在哪里寻找什么项目。每个团队都是不同的，甚至团队中的个人也不一定遵守任何团队标准。

我不是在寻找具体的产品或建议，什么应该标准化。我还更感兴趣的是大型组织/企业使用的标准是什么。

Answer 1

有许多国际标准化组织的技术文档标准，如En.wikipar.org/wiki/Technical_文档所列。维基百科的文章暗示，这些都是特定于某些行业(而实际的ISO标准并不容易在公共领域AFAIK).

例如，对于软件开发，IEEE 12207也管理文档。

但是，内部文档的全部内容是，大多数组织通常都希望做任何对他们特别有用的事情，而不是遵循外部标准。

在尝试执行一项标准之前，如果是这样的话，您就已经超过了曲线：

• 实际生成的文档
• 文档可供需要的人使用(在需要时可以搜索和找到，然后也可以访问.)
• 维护和更新文档

作为一个IT部门，而不是试图创建和/或执行任何特定的标准，仅仅是通过提供一个好的内部搜索引擎来提供便利。

Answer 2

我不知道任何行业标准，但我在内部文档方面拥有的最好经验是在一个有专门团队负责支持和管理文档基础设施的组织中。但是他们自己并不负责编写所有的文档。

他们使用的系统碰巧是wiki，但是任何单一的真理来源都应该有效。我甚至认为它应该支持版本控制。没有什么比我不能忍受的了，人们在Word文档周围发电子邮件，有多个页面专门用于文档更改。如果您需要一个当前版本的副本，它应该足够容易从源代码导出为PDF。

团队中的大多数人都有科技写作背景。他们负责开发通用文档类型的模板。他们会帮助其他团队开始编写自己的文档。他们会对人们正在创建的文档进行审核，并可能对它们进行编辑，以确保样式/一致性。那是光荣的。

老实说，写好文档需要时间和精力。没有什么神奇的工具能让它变得简单。某一系统的中小企业必须愿意为其各种系统/项目编写(并不断更新)文件。

Answer 3

我不能谈论特别大的组织，但最多是任何规模的组织标准，并实施它(在合理的范围内)，以便所有这样的文档都在一个平台上，最好是一个具有访问控制和搜索功能的平台，这是一个巨大的进步。

至于合法的标准和标准实践，我发现这文章详细介绍了如何开发自己的标准，以及可能需要考虑的因素，并引用了相关的ISO标准。

我相信，就定义的标准而言，这就是全部，所以它只是创建适合您的组织需求的标准。