Обновлён документ «Принципы создания документации»
Дата публикации: 2025-02-12Опубликована новая версия документа «Принципы создания документации». Обновление касается как структуры, так и чёткости формулировок ключевых понятий.
Основное внимание уделено синхронизации когнитивного контекста между автором и читателем, а также выстраиванию иерархии информации — от общего к частному. В документ добавлены улучшенные рекомендации по форматированию, ориентированному на работу с LLM: структура Markdown, расположение ключевых блоков, единообразие терминов.
Если вы занимаетесь проектной документацией или пишете инструкции для ИИ и людей — эта версия может быть полезна. В ней — о том, как выстраивать логику, вовлекать читателя и обеспечивать удобную навигацию.