awesome-docs

Awesome Docs

Keep project knowledge easy to find, check, and update. Choose the document type and path by what the reader needs, and preserve enough context for another person or agent to continue the work without guessing.

Standalone Use and Optional Skills

This skill supplies its own writing, illustration and review workflow. Use another skill only when it is listed as available in the current environment and adds value to the task; read its actual provided path, not an assumed sibling directory. If it or its relevant reference is missing, skip that enhancement and continue locally. Do not scan other agents' installations, install/update skills or prompt for installation as part of documentation work. If the user explicitly requested a missing skill, briefly disclose that it was not loaded rather than claiming to have used it.

Shared Writing and Illustration Guides

For substantial writing or explanation rewrites, read technical-writing.md: executable passes for reader questions, evidence and terminology, prerequisite order, findable headings, paragraph reasoning, actionable procedures, comparable reference tables, reproducible calculations and defect-based review. Each pass specifies what to inspect and how to repair a failed check. These rules apply to Markdown, HTML prose and teaching scripts. Small edits use only relevant checks.

When figures or interactive documents are needed, also read interactive-illustrations.md: LaTeX in all formulas, retained context with focused highlights, meaningful 3D/2D views, and interaction/delivery checks. Resolve the explanation before choosing effects. Architecture flows normally need 2D; spatial relationships often benefit from 3D. Do not force either on a small text task.

Document type still determines the writing order and depth below. Keep facts, logic, notation and audience fit ahead of presentation polish. The shared guides own these rules; specialized guides add only their domain-specific execution steps.