Write documentation that stays true, and find what a change just made false. Covers picking the right kind of document (tutorial, how to, reference, explanation), auditing docs for drift after shipping, writing a runbook someone can follow at 3am, and deciding what not to write. Use when adding or updating a README, runbook, or API docs, when a change alters behaviour someone has written down, after shipping a feature, when onboarding docs are wrong, or on any mention of documentation, docs, or a runbook.
Write and maintain technical documentation. Trigger with "write docs for", "document this", "create a README", "write a runbook", "onboarding guide", or when the user needs help with any form of technical writing — API docs, architecture docs, or operational runbooks.
文档更新与维护。检查并更新README.md、CHANGELOG.md、SECURITY.md、部署文档和.gitignore模板。Use when the user asks to update documentation, sync changelog, or prepare release docs.
Documentation standards and required templates for this project. Use this skill whenever producing any project document — feature plans, handoffs, release notes, capability documentation, production release records, or incident reports. Also trigger it when a plan, release, deployment, or incident occurs without documentation, because in this project undocumented work is unfinished work.
Write, maintain, refactor, or review engineering documentation. Use for README files, architecture and API documentation, operational documentation, documentation consistency, or checking documentation against implemented behavior. Respect project conventions and use planning for new specifications, RFCs, ADRs, and implementation plans.
Software delivery documentation dispatcher. Routes to the correct document standard for the artifact being written or reviewed, following the BRD -> PRD -> FRD/NFR -> TRD -> SAB -> SAD -> ADR lifecycle. Use whenever creating, reviewing, auditing, or improving any software project document. Trigger on: "write a BRD", "PRD", "product requirements", "functional spec", "FRD", "TRD", "NFR", "document review", "business requirements", "acceptance criteria", "developer handoff", "write an ADR", "architecture decision", "write a SAD", "solution architecture", "traceability", "epic", "user story", "feature list", "roadmap", "release plan", "prioritize features", "MoSCoW", "RICE", "runbook", "postmortem", "go-live checklist", or any request to produce or improve a software delivery document.
Write, review, and organize project documentation, including READMEs, guides, product comparisons, release notes, code comments, TSDoc/JSDoc, and public API reference. Use when editing documentation or comments, writing comparison content, reviewing a diff that touches them, or deciding what to document and where it belongs.
Diátaxis Documentation Expert. An expert technical writer specializing in creating high-quality software documentation, guided by the principles and structure of the Diátaxis technical documentation authoring framework.
Rising2 mentions in 2 weeks
42 projects use a version of this
41k18d agoReviewMountCreate a free account to mount
Guidance for structuring Ark documentation using the Diataxis framework. Use this skill when creating new docs, deciding where content belongs, reviewing documentation PRs, or restructuring existing documentation.
4387mo agoReviewMountCreate a free account to mount
Go documentation conventions: godoc comments, package docs, testable Example functions, deprecation notices, doc links, and project docs (README, CHANGELOG, llms.txt). Use when: "add godoc", "document this package", "write doc comments", "add examples to docs", "deprecate a function", "write a README", "update the changelog", "improve the docs". Not for: commit messages (git-commit), code style (go-coding-standards).
8528d agoReviewMountCreate a free account to mount
Records decisions and documentation. Use when you need to document an architecture decision (ADR) or the reasoning behind a design choice, when changing public APIs, shipping features, or when you need to record context that future engineers and agents will need to understand the codebase.
Create and update documentation articles for the Heym platform. Use when adding docs pages, writing reference articles from summaries, or when the user provides an outline for a new article.
1.4k7mo agoReviewMountCreate a free account to mount
Use when writing a README, documenting a module or component, recording a decision, or deciding whether something needs explaining at all. Also when documentation has drifted from the code.
Documentation suites: audit or plan docs, write with Diátaxis/Info Mapping/EPPO, review for scannability and AI-readiness. Trigger for doc planning, writing, or review. Broken links are doc-link-verifier, not this.
Redaction de documentation technique: README, docs API, guides, changelogs. Use when writing or improving technical documentation, README files, or developer guides.
Rédiger de la documentation technique ou utilisateur. À utiliser pour commencer une fonction ou un script, pour expliquer comment un module fonctionne, pour créer un tutoriel, une notice d'utilisation, ou compléter le README.
After finishing a non-trivial code change (new feature, bug fix, refactor, architecture decision), update the project's root documentation files — CLAUDE.md, SPEC.md, README.md, or whatever equivalent already exists — so a future agent or teammate can open the project cold and understand what it does, what changed, and how to continue. Create these files if none exist. Use at the end of a change, not before or during. Do not use for trivial edits (typo fixes, one-line tweaks, formatting) or read-only/exploratory work with no code change. Works in any conversation language, English or French included — write the documentation in whatever language the existing docs use, or the user's language if there's no precedent.
Write clear, comprehensive documentation with language-specific patterns. Use when writing docstrings, module docs, README files, API references, or architecture decision records. Covers Python, TypeScript, Go, and Rust documentation conventions. Do NOT use for code style (use vibe skill).
Plain text files in a repository that tell a coding agent how the project works: commands to run, conventions to follow and things to avoid. CLAUDE.md, AGENTS.md, cursor rules and skills are the common kinds.
CLAUDE.md or AGENTS.md?
CLAUDE.md is read by Claude Code. AGENTS.md is an open format that Codex, Cursor and other agents read. Many projects keep one and point the other at it.
What is a skill?
A folder with a SKILL.md that describes one capability, such as filling PDFs or reviewing code. The agent loads it only when the task calls for it.
Can I search my own team's files too?
Your agents already can, over MCP, limited to the files you're allowed to read. Searching them from this page is coming.
Mehul72Reads credentialsSkill
