Критерии хорошей документации для Tech продукта.
Простые критерии для быстрой оценки пригодности текущей документации для внутреннего использования или использования техническим сообществом.
1 min readJan 31, 2024
- Актуальность: Соответствие текущему состоянию проекта/продукта.
- Полнота: Все аспекты разработки должны быть включены в документацию, в том числе ТЗ, ограничения, тех долг, архитектура, API, функционал и процедура развертывания и ведения разработки, включая тестирование, лицензия.
- Понятность для целевой аудитории: Использование технического жаргона и сложных терминов должно быть минимизировано.
- Доступность: Легкий и быстрый доступна всем участникам проекта или сообщества. Желательно использование систем управления документацией, которые поддерживают совместную работу и контроль версий.
- Однозначность и согласованность: Не должно быть внутренних противочеий и возможности широко толковать тезисы.
- Визуализация: Использование схем, диаграмм и иллюстраций для объяснения сложных концепций.
- Примеры использования: Практические примеры как использовать продукт или систему.
- Обратная связь: Возможность для пользователей оставлять комментарии или задавать вопросы по документации.
- Соблюдение стандартов: Следование стандартам компании, отраслевым и международным стандартам указанным в ТЗ.
- Международизация: Перевод документации на разные языки, если проект предполагает международное использование.
