Scaffold Docs

Construit itérativement une documentation technique de haute qualité pour les bibliothèques de code via un flux de travail structuré, descendant, avec revue utilisateur intégrée.

déclencheurs:write docs fordocument this librarywrite technical docsupdate the docsdocs are stalesync the docs with the code

GitHub SKILL.md

Ce qu'il fait

Ce skill transforme une base de code en une documentation technique professionnelle. Au lieu d'une génération unique, il utilise un processus itératif en plusieurs phases pour garantir que la documentation est précise, alignée sur l'audience et de haute qualité.

Quand l'utiliser

Utilisez ce skill lorsque vous devez documenter une nouvelle bibliothèque, actualiser une documentation obsolète ou créer un ensemble complet de guides (Démarrage rapide, Approfondissement et Référence) pour une base de code.

Ce qui est inclus

Instructions : Un flux de travail rigoureux en 5 phases couvrant la découverte, les tutoriels guidés, les guides thématiques approfondis et les références API.
Méthodologie : Des vérifications intégrées de la qualité de la prose (inspirées de Strunk & White) et une approche « modèle mental d'abord » pour s'assurer que la documentation est utile pour les humains, et non un simple miroir du code.
Portes de revue : Des points de contrôle obligatoires entre les passes structurelles et de prose pour prévenir les hallucinations et garantir l'alignement.

Agents compatibles

Conçu pour les agents capables de gérer des espaces de travail multi-fichiers et d'exécuter des flux de travail itératifs (ex: Claude Code, Codex, Gemini CLI).

Étiquettes

#documentation #technical-writing #workflow #code-analysis #knowledge-management

Pas encore audité

Cette compétence n'a pas encore été examinée par notre pipeline d'audit automatisé.

Informations

Dépôt: scaffold-docs-skill
Étoiles: 81

Compétences similaires

Maestro Orchestrate

Orchestrates complex engineering workflows with enforced design and approval gates, child-agent delegation, and session state management.

Run Execute

Orchestrates execution of work items across modes (autopilot, confirm, validate) with scripted init/complete tooling, plan/test/report artifacts and strict gati

Chinese Software Copyright Application

Generate complete Chinese software copyright application materials (application form, code documentation, user manual, design docs) and export them to PDF from

Ip2Location IO Automation (Composio)

Automate Ip2location IO tasks via Composio's Rube MCP toolkit — discover tools, verify connections, and execute schema-compliant workflows safely.

CTF Write-up Generator

Generate a concise, reproducible submission-style CTF writeup with a one-path solution script, metadata, and a short checklist for fast verification.

Verifying Markdown Formatting

Checks Markdown files for structural and stylistic formatting issues (headings, lists, code blocks, links) and applies deterministic fixes.

Code Spec Backfill

Identify missing function-level contracts and backfill docstrings and type annotations; report ambiguous gaps with misuse scenarios. Incremental, state-driven w

Azure External Attack Surface Management

Provides expert guidance for Azure External Attack Surface Management (EASM): quotas, configuration, integrations, and exporting inventory to analytics platform

Retour aux compétences