Updated document "Documentation Creation Principles"
Publication date: 2025-02-12A new version of the document "Documentation Creation Principles" has been published. The update affects both the structure and the clarity of key concept formulations.
The main focus is on synchronizing the cognitive context between the author and reader, as well as building an information hierarchy - from general to specific. The document now includes improved recommendations for LLM-oriented formatting: Markdown structure, placement of key blocks, and terminology consistency.
If you work with project documentation or write instructions for AI and humans - this version may be useful. It covers how to structure logic, engage readers, and ensure convenient navigation.
Discuss This Publication
If you would like to discuss this piece, ask a question, or continue the conversation, join my Telegram channel.
On the channel I publish new materials, working notes, and announcements, while the site hosts the full texts and structured long-form publications.