docs-codebase

Solid

Technical writing for READMEs, ADRs, API docs, and changelogs. Use when revising or consolidating a repo documentation folder.

AI & Automation 80 stars 17 forks Updated 1 weeks ago MIT

Install

View on GitHub

Quality Score: 83/100

Stars 20%
64
Recency 20%
90
Frontmatter 20%
70
Documentation 15%
100
Issue Health 10%
80
License 10%
100
Description 5%
100

Skill Content

# Technical Documentation Execution-ready patterns for clear, maintainable technical documentation. **Modern best practices (January 2026)**: docs-as-code, ownership + review cadence, documentation QA gates (links/style/spelling), AI-assisted drafting + review, OpenAPI 3.2.0 where streaming schemas matter, and GEO (Generative Engine Optimization) for AI search. ## Quick Reference | Documentation Type | Template | When to Use | |-------------------|----------|-------------| | **Project README** | [readme-template.md](assets/project-management/readme-template.md) | New project, onboarding | | **Architecture Decision** | [adr-template.md](assets/architecture/adr-template.md) | Technical decisions | | **API Reference** | [api-docs-template.md](assets/api-reference/api-docs-template.md) | REST/GraphQL APIs | | **Changelog** | [changelog-template.md](assets/project-management/changelog-template.md) | Version history | | **Contributing Guide** | [contributing-template.md](assets/project-management/contributing-template.md) | Open source, teams | ## Workflow 1. Identify the documentation type and audience. 2. Find existing patterns in the repo; follow local conventions. 3. Start from the closest template in `assets/` and adapt. 4. Add ownership + review cadence for critical docs (runbooks, onboarding, API reference). 5. Run documentation QA (links, formatting, spelling, examples) before merging. ### Docs Folder / LLM-Generated Revamp Mode (Any Repo) Use this mode when a repo'...

Details

Author
vasilyu1983
Repository
vasilyu1983/AI-Agents-public
Created
9 months ago
Last Updated
1 weeks ago
Language
Python
License
MIT

Integrates with

Similar Skills

Semantically similar based on skill content — not just same category