template-documentation-creation
Author or refresh AGENTS.md and README.md for template directories — accurate commands, Mermaid where helpful, link _generated/active_projects.md. USE WHEN folder needs AGENTS, README audit, doc contract fix, or signposting after code change — even without documentation_creation prompt.
Best use case
template-documentation-creation is best used when you need a repeatable AI agent workflow instead of a one-off prompt.
Author or refresh AGENTS.md and README.md for template directories — accurate commands, Mermaid where helpful, link _generated/active_projects.md. USE WHEN folder needs AGENTS, README audit, doc contract fix, or signposting after code change — even without documentation_creation prompt.
Teams using template-documentation-creation should expect a more consistent output, faster repeated execution, less prompt rewriting.
When to use this skill
- You want a reusable workflow that can be run more than once with consistent structure.
When not to use this skill
- You only need a quick one-off answer and do not need a reusable workflow.
- You cannot install or maintain the underlying files, dependencies, or repository context.
Installation
Claude Code / Cursor / Codex
Manual Installation
- Download SKILL.md from GitHub
- Place it in
.claude/skills/documentation-creation/SKILL.mdinside your project - Restart your AI agent — it will auto-discover the skill
How template-documentation-creation Compares
| Feature / Agent | template-documentation-creation | Standard Approach |
|---|---|---|
| Platform Support | Not specified | Limited / Varies |
| Context Awareness | High | Baseline |
| Installation Complexity | Unknown | N/A |
Frequently Asked Questions
What does this skill do?
Author or refresh AGENTS.md and README.md for template directories — accurate commands, Mermaid where helpful, link _generated/active_projects.md. USE WHEN folder needs AGENTS, README audit, doc contract fix, or signposting after code change — even without documentation_creation prompt.
Where can I find the source code?
You can find the source code on GitHub using the link provided at the top of the page.
Related Guides
SKILL.md Source
# Documentation creation ## Natural invoke - "Write AGENTS.md for projects/templates/template_code_project/scripts/" - "README and AGENTS for new infrastructure package" - "Fix stale commands in docs/prompts AGENTS.md" ## Inputs to confirm - **Directory** — path to document. - **Audience** — AGENTS (technical/API) vs README (quick nav). ## Workflow 1. **Read live code** — list modules, entrypoints, tests; do not invent APIs. 2. **AGENTS.md** — purpose, layout diagram, public functions/signatures or pointers, verification commands, see-also links. 3. **README.md** — short index, quick commands, link to AGENTS. 4. **Cross-links** — relative paths; active project names → [`docs/_generated/active_projects.md`](../../_generated/active_projects.md). 5. **Tone** — understated; show not tell; trim non-semantic adjectives. 6. **Validate** — `uv run python scripts/lint_docs.py` when touching many md files. ## Deliverables - Updated AGENTS.md + README.md (and SKILL.md if agent-routable folder) ## Verification commands ```bash uv run python scripts/lint_docs.py # Spot-check links mentioned in docs resolve ``` ## When NOT to use - **Full repo audit** → [comprehensive-assessment](../comprehensive-assessment/SKILL.md) - **Manuscript prose** → manuscript skills ## References - [`docs/rules/documentation_standards.md`](../../rules/documentation_standards.md)
Related Skills
infrastructure-documentation
Skill for the documentation infrastructure module providing figure management, image handling, markdown integration, and API glossary generation. Use when managing research figures, inserting images into manuscripts, auto-numbering figures, or generating API documentation.
template-validation-quality
Run validation CLI, prerender, markdown/PDF/integrity gates, and QA workflows for the Research Project Template. USE WHEN validate manuscript, check PDF for ?? refs, prerender gate, link checker, output integrity, or pre-commit validation — even without validation_quality prompt.
template-test-creation
Create pytest suites under the no-mocks policy — real data, temp files, subprocess, pytest-httpserver. USE WHEN adding tests, raising coverage, testing new src/ module, or user forbids mocks.
template-reproducibility-audit
Deterministic reproducibility audit — fixed seeds, regenerate-from-clean, double-run diff before Zenodo/arXiv/release. USE WHEN outputs drift between runs, "worked on my machine", need regenerate-from-clean proof, or pre-release reproducibility check — even without naming docs/prompts.
template-refactoring
Clean-break refactors with migration for the Research Project Template — move logic to src/, split modules, rename APIs with test updates. USE WHEN restructuring code, extracting modules, removing duplication, or migration without behavior change.
template-pipeline-debugging
Systematic pipeline DAG failure triage for the Research Project Template. USE WHEN ./run.sh or execute_pipeline.py fails, a stage stalls (setup, tests, analysis, render, validate, LLM, copy), pytest/coverage gate fails mid-pipeline, PDF render or validate breaks, Project Analysis finishes too fast with no figures, or user says pipeline debug, stage failed, resume checkpoint, core-only triage — even without naming this skill or docs/prompts.
template-methods-orchestration
Repo-wide methods orchestration workflow for the Research Project Template. USE WHEN the user asks to add, audit, improve, or validate methods, methodology, method contracts, stage-to-method wiring, artifact/evidence provenance, or orchestration across template projects.
template-manuscript-cross-references
Audit or author registry-driven manuscript cross-refs — labels.yaml, [[FIG:]], [[THMREF:]], [[VAR:]] tokens. USE WHEN fixing figure/equation/theorem numbering, orphan registry keys, hard-coded "Theorem 7.3" in prose, or [[MISSING:]] injection failures — even for Pandoc projects that also use a YAML registry.
template-manuscript-creation
Scaffold a research manuscript and project layout from a research brief — sections, config.yaml, src/, scripts/, tests. USE WHEN starting a new paper, new projects/ tree, manuscript from topic description, or aligning with template_code_project exemplar — even without copy-paste prompts.
template-manuscript-claim-verification
Triple-pass verification of every manuscript claim against code, data, refs, and renderer; repair prose while staying renderable. USE WHEN pre-submission, pre-Zenodo, pre-arXiv, abstract numbers disagree with CSV, citations do not support sentences, or user asks to triple-check / verify every claim — even without docs/prompts. Not for casual PDF summary.
template-feature-addition
End-to-end feature work across src/, scripts/, tests/, manuscript, and docs for the Research Project Template. USE WHEN adding a pipeline-visible feature, new analysis stage, manuscript-facing output, or cross-layer integration — even without feature_addition prompt.
template-deep-research
Template-native research intake, literature search, source verification, synthesis, fact-checking, and systematic-review planning. USE WHEN the user asks to research a topic, build a literature corpus, fact-check claims, prepare a PRISMA-style review, or clarify a research question before manuscript work.