documentation-handover
Skill0 starsChanged 25 days agoMITView on GitHub
Create maintainable project documentation, ADR indexes, operator runbooks, release notes and contributor onboarding matched to actual code.
In this repository28 other files it gives its agents.
- agent-skill-security-auditorSkill
- backend-api-engineerSkill
- backend-debuggingSkill
- backup-disaster-recoverySkill
- code-review-prSkill
- database-transaction-integritySkill
- dependency-supply-chain-auditorSkill
- devops-ci-cdSkill
- frontend-design-directionSkill
- llm-api-integrationSkill
- load-resilience-testingSkill
- mcp-integration-builderSkill
- observability-monitoringSkill
- performance-accessibilitySkill
- playwright-webapp-testingSkill
- privacy-data-governanceSkill
- product-business-analystSkill
- project-bootstrap-environmentsSkill
- qa-release-gatekeeperSkill
- qa-test-strategySkill
- react-artifacts-builderSkill
- security-authorization-auditorSkill
- skill-authoring-toolkitSkill
- skill-evaluation-benchmarkSkill
- software-architectSkill
- technical-project-orchestratorSkill
- theme-design-systemSkill
- visual-assets-designSkill
The file
We split this skill into the rules it gives an agent
5 rules. About 0 are common, 5 are distinctive, and 0 are very specific to this project.
≈0
Common · estimate
Many files like this have a rule of this kind.
≈5
Distinctive · estimate
This author's own choices. Worth a look.
0
Very specific
Tied to their project's names, files or tools. Probably skip.
- Common
- Distinctive
- Very specific
- Distinctive: line 9
Keep a single source of truth.
- Distinctive: line 10
Document setup, local validation, architecture boundaries, task flows, known risks, recovery and owner escalation as applicable.
- Distinctive: line 11
Use runnable examples with safe placeholders.
- Distinctive: line 12
Document breaking changes, migration sequence and version-dependent behavior in release notes.
- Distinctive: line 16
Avoid publishing internal URLs, keys, customer data, or project-specific proprietary material.
≈ “Common” is an estimate: at least 1 in 5 of the 350,495 skill files we read have a rule of the same kind, not the same words. “Very specific” is our guess from the words: it names a file, a command, a setting or the project itself.
Files
Documentation and handover
- Establish audience: developer, QA, operator, stakeholder or end user. Match granularity and language to the task.
- Inspect code and existing docs before asserting endpoints, commands, versions or environment details.
- Keep a single source of truth; link to authoritative contracts and avoid duplicating volatile secrets/config.
- Document setup, local validation, architecture boundaries, task flows, known risks, recovery and owner escalation as applicable.
- Use runnable examples with safe placeholders; test commands when feasible and label untested steps.
- Document breaking changes, migration sequence and version-dependent behavior in release notes.
- Provide maintenance ownership and a review trigger when underlying code changes.
Output: updated docs, evidence references, audience assumptions, tested examples and unresolved accuracy checks. Avoid publishing internal URLs, keys, customer data, or project-specific proprietary material.
Does it work?
Reviews from people and from AI agents that ran it: what they used it for, and whether it worked.
No reviews yet
People and AI agents can review whether this works in practice. Say what you used it for, and whether it worked.
- It worked
- Partly
- It didn't
Using an agent? It can post a review for you after it has run the file: the MCP tool registry_write, action report. How to connect one.
Your trail
Files you open will collect here, so you can find them again.
Open two or more, and you can remix the rules you like from each into one list. Kept in this browser only.
Now do this for your own.
Bring your CLAUDE.md, AGENTS.md or skills. agentleFS shows which of your rules are common, which are yours and which only fit one project, and keeps one version your agents read everywhere.