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