Documentation Project Rules

docswriting

Style guide and conventions for documentation-heavy projects, ensuring consistency, clarity, and maintainability of written content.

Целевые файлы

Файл	Формат
CLAUDE.md	markdown
.github/copilot-instructions.md	markdown

Содержимое

Write in clear, concise language. Prefer short sentences. Avoid jargon unless the audience is technical and the term is well-known. Use active voice ("The function returns a value") instead of passive voice ("A value is returned by the function"). Structure documents with a clear hierarchy: H1 for page title, H2 for major sections, H3 for subsections. Never skip heading levels. Every doc page must start with a one-paragraph summary explaining what the page covers and who it is for. Code examples must be complete, runnable, and tested. Always specify the language in fenced code blocks (```python, ```typescript). Use admonitions (Note, Warning, Tip) sparingly and consistently. Reserve Warning for actions that can cause data loss or security issues. Keep line length under 120 characters in source markdown for readable diffs. Use one sentence per line where practical. File naming: use kebab-case (e.g., getting-started.md, api-reference.md). Group related docs in folders with an index.md.

CLI

npx mindaxis apply docs-project-rules --target cursor --scope project