project-documentation

Installation
SKILL.md

Project Documentation Skill

Use this skill when writing, reviewing, or improving project documentation. The goal is documentation that is current, concrete, easy to navigate, rendered by MkDocs when applicable, and useful for both humans and coding agents.

Core Principle

Each document should have one clear job.

Do not duplicate the same information in many places. Put full details in one canonical document and link to it from other places.

Project documentation should cover both application requirements (what the application should do) and implementation details (how the code works).

Requirements First

Any addition, change, or removal of an application functionality requirement must be reflected in docs/docs/requirements/ before implementation. Then implement in the Recommended Implementation Order from references/application-requirements.md.

For all other documentation (README, AGENTS.md, architecture), update it when the user asks for documentation, the task explicitly requires documentation, or the change clearly makes existing documented behavior inaccurate. Do not write new documentation files for ordinary code changes.

Write architecture documentation only when the user or developer explicitly asks for it. Not otherwise.

Installs
3
First Seen
Jul 5, 2026
project-documentation — zdeneklapes/skills