afrexai-technical-docs
Complete technical documentation system — from planning through maintenance. Covers READMEs, API docs, guides, architecture docs, runbooks, and developer portals. Includes templates, quality scoring, and automation.
Best for technical writersWorks with GitHubLow risk
⌘source
- author
@LeoYeAI- language
- Python
★2kstars
306forks
May 6, 2026
✦overview.md
Key Features
- ·Documentation audit with scoring
- ·Templates for READMEs, API docs, guides
- ·Quality scoring and maintenance automation
Use Cases
- →Audit existing project documentation for coverage
- →Generate complete technical docs from templates
- →Standardize documentation across a development team
Best for
- ✓technical writers
- ✓development teams
- ✓open-source maintainers
Not ideal for
- !non-technical audiences
- !marketing content
FAQs
name
Technical Documentation Engine
description
Complete technical documentation system — from planning through maintenance. Covers READMEs, API docs, guides, architecture docs, runbooks, and developer portals. Includes templates, quality scoring, and automation.
metadata:{"category":"writing","skills":["documentation","technical-writing","api-docs","readme","devdocs","runbooks"]}
Technical Documentation Engine
You are a technical documentation expert. You create, review, and maintain documentation that developers actually read and trust. Every document has a purpose, an audience, and a shelf life.
Phase 1 — Documentation Audit
Before writing anything, assess what exists.
Audit Checklist
Run through the codebase or project and score each area (0-3):
- 0 = Missing entirely
- 1 = Exists but outdated/wrong
- 2 = Exists, mostly correct, gaps
- 3 = Complete, current, useful
audit:
project: "[name]"
date: "YYYY-MM-DD"
scores:
readme: 0 # Root README with install + quickstart
getting_started: 0 # Tutorial for first-time users
api_reference: 0 # Every endpoint/function documented
architecture: 0 # System design, data flow, decisions
guides: 0 # Task-oriented how-tos
runbooks: 0 # Operational procedures
contributing: 0 # Dev setup, PR process, style guide
changelog: 0 # Version history with migration notes
troubleshooting: 0 # Common errors and solutions
deployment: 0 # How to deploy, environments, config
total: 0 # out of 30
grade: "F" # A(27-30) B(22-26) C(17-21) D(12-16) F(<12)
$install
1-click copynpx skills add LeoYeAI/openclaw-master-skills --skill afrexai-technical-docsSafety assessment
★
Clarity score
How clear and easy to understand the SKILL.md instructions are, rated from 1 to 5.
5/ 5
excellentVery clear and well structured, with almost no room for misunderstanding.
◎
Actionability score
How directly an agent can act on the SKILL.md instructions, rated from 1 to 5.
5/ 5
very highHighly actionable with clear, concrete steps that an agent can follow directly.