Организация, в которой я работаю, растет, и с этим ростом приходит зрелость, а с этой зрелостью возникает потребность в лучшем документировании.
Сегодня это мешанина каталогов, вики, OneNotes, и ни один из них не стандартизован с точки зрения формы или содержания, маркировки или даже знания того, где какой элемент искать. Каждая команда индивидуальна, и даже отдельные члены команды не обязательно придерживаются каких-либо командных стандартов.
Я не ищу конкретных продуктов или советов по стандартизации. Меня также больше интересует, какие стандарты используют более крупные организации / предприятия.
Существует ряд стандартов ISO для технической документации, перечисленных на en.wikipedia.org/wiki/Technical_documentation. Статья в Википедии подразумевает, что они относятся к определенным отраслям (и фактические стандарты ISO не так легко доступны в открытом доступе AFAIK) ...
Например, для разработки программного обеспечения IEEE 12207 также регулирует документацию.
Но вся проблема с внутренней документацией заключается в том, что довольно часто большинство организаций хотят делать то, что специально для них работает, а не следовать внешним стандартам.
Прежде чем пытаться обеспечить соблюдение стандарта, вы уже значительно опережаете график, если и когда:
И как ИТ-отдел, вместо того, чтобы пытаться создавать и / или обеспечивать соблюдение каких-либо конкретных стандартов, просто упрощайте создание экземпляров, предоставляя хорошую внутреннюю поисковую систему
Я не знаю ни о каких отраслевых стандартах, но лучший опыт работы с внутренней документацией у меня был в организации, которая имела преданная команда ответственный за поддержка и кураторство инфраструктура документации. Но они были не отвечает за написание всей документации.
Система, которую они использовали, оказалась вики, но любой единственный источник правды должен работать. Я бы даже сказал, что он должен изначально поддерживать управление версиями. Нет ничего, что я терпеть не мог бы больше, чем люди, рассылающие по электронной почте документы Word с несколькими страницами, посвященными журналу изменений документа. Если вам нужна копия текущей версии, ее должно быть достаточно легко экспортировать из источника в формате PDF.
У большей части команды был технический писательский опыт. Они отвечали за разработку шаблонов для общих типов документации. Они помогли бы другим командам начать писать свои собственные документы. Они будут проверять документы, которые люди создают, и потенциально редактировать их для стиля / согласованности. Это было великолепно.
И давайте будем честными, написание хорошей документации требует времени и усилий. Нет волшебного инструмента, который бы облегчил это. МСП данной системы должны быть готовы писать (и постоянно обновлять) документацию для своих различных систем / проектов.
Я не могу говорить об особо крупных организациях, но не более чем любого размера, придумывая достаточно хорошо организованный стандарт и применяя его (в разумных пределах), чтобы вся такая документация находилась на одной платформе, желательно с контролем доступа и поиском. Возможности - это огромный шаг вперед.
Что касается законных стандартов и стандартной практики, я обнаружил этот опубликуйте подробное описание того, как вы могли бы разработать свой собственный, и какие факторы, возможно, необходимо учесть, а также ссылки на соответствующие стандарты ISO.
Я считаю, что это все, что касается определенных стандартов, поэтому все сводится к созданию стандартов, адаптированных к потребностям вашей организации.