generate-service-documentation
Skill7 starsChanged 2 months agoMITView on GitHub
Use when creating or refreshing a service record, ownership document, runbook index, or operational documentation from repository and deployment evidence. Produces a reviewable draft and never invents owners, SLOs, or dependencies.
1 other project uses a version of this.
Adopted by
Most recently taken up by
- Raashul/claude-skillstheir own version, first seen Apr 30, 2026
Other versions1 project uses a version of this.
Word for word · 0
None found.
Edited · 0
None found.
Wrote their own version · 1
- Raashul/claude-skills★ 1same name
How matches are found. Word for word: the exact same text. Edited: shares passages with this file (“99% same” means 99% of its five-word phrases also appear here; 10% or more counts). Their own version: similar meaning, or, weakest, the same name. We can’t tell which project had it first. Projects are counted among the 200 most-starred candidates, and mentions are links to the repository we found, up to 50 per site, so both counts are a floor.
In this repository29 other files it gives its agents.
- AGENTS.mdAGENTS.md
- address-pr-commentsSkill
- build-and-scan-container-imageSkill
- execute-database-migrationSkill
- generate-adrSkill
- get-pr-commentsSkill
- incident-triageSkill
- install-dev-toolsSkill
- prepare-releaseSkill
- remediate-dependency-vulnerabilitiesSkill
- review-configurationSkill
- twg-agentic-searchSkill
- twg-artifactsSkill
- twg-code-reviewSkill
- twg-confluenceSkill
- twg-context-discoverySkill
- twg-engineering-workSkill
- twg-jira-resolve-merged-workSkill
- twg-jiraSkill
- twg-operational-healthSkill
- twg-responsibility-routingSkill
- twgSkill
- twg-space-creationSkill
- twg-status-rollupsSkill
- validate-and-deploy-iacSkill
- validate-and-deploy-kubernetesSkill
- validate-documentationSkill
- validate-github-actionsSkill
- verify-service-healthSkill
The file
We split this skill into the rules it gives an agent
3 rules. About 0 are common, 3 are distinctive, and 0 are very specific to this project.
≈0
Common · estimate
Many files like this have a rule of this kind.
≈3
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 29
Write only with explicit permission.
- Distinctive: line 33
Never invent an owner, contact, SLO, credential, or recovery guarantee.
- Distinctive: line 34
Do not include secrets or private telemetry.
≈ “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
Generate Service Documentation
Build a service record from code, deployment, ownership, and observability evidence.
Parameters
projectPath: service repository; default workspace root.outputPath: destination document; defaultSERVICE.md.sources: optional files or directories to inspect.includeRunbook: defaulttrue.format: Markdown or JSON; default Markdown.failOnUnknown: defaultfalse.
Workflow
- Inspect repository metadata, deployment files, CI workflows, routes, manifests, dashboards, and existing documentation.
- Extract purpose, owners, environments, dependencies, data classification, lifecycle, SLOs, alerts, recovery procedures, and escalation paths.
- Mark every inferred or missing value explicitly as unknown.
- Generate a draft with source references and review prompts.
- Validate links, commands, and paths in the draft.
- Write only with explicit permission; otherwise return the draft in memory.
Safety
- Never invent an owner, contact, SLO, credential, or recovery guarantee.
- Do not include secrets or private telemetry.
- Preserve existing service documentation unless replacement is authorized.
Output
Return the draft path or content, evidence sources, unknown fields, stale references, and required owner review.
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.