documentation-patterns
FeaturedTechnical documentation patterns for READMEs, ADRs, API docs (OpenAPI 3.1), changelogs, and writing style guides. Use when creating project documentation, writing architecture decisions, documenting APIs, or maintaining changelogs.
Install
Quality Score: 89/100
Skill Content
Details
- Author
- yonatangross
- Repository
- yonatangross/orchestkit
- Created
- 8 months ago
- Last Updated
- today
- Language
- TypeScript
- License
- MIT
Integrates with
Similar Skills
Semantically similar based on skill content — not just same category
docs-codebase
Technical writing for READMEs, ADRs, API docs, and changelogs. Use when revising or consolidating a repo documentation folder.
docs-patterns
Documentation writing conventions -- style, structure, tone, and quality standards.
doc-standards
Neutral, portable documentation templates and standards — design docs (HLD/LLD), ADRs, release notes, user guides, runbooks, API references, READMEs — plus rules for grounding every claim in code and adapting to a project's existing doc style/tooling (Markdown or Confluence, and its chosen diagram format). Use when writing or reviewing structured documentation.