am-agent-code-documenter
Skill27 starsChanged 2 months agoMITView on GitHub
Create comprehensive technical documentation, API docs, and inline code comments. Specializes in documentation generation, maintenance, and accessibility. Use PROACTIVELY for documentation tasks and knowledge management.
In this repository167 other files it gives its agents.
- AGENTS.mdAGENTS.md
- src/AGENTS.mdAGENTS.md
- CLAUDE.mdCLAUDE.md
- add-agent-targetSkill
- add-global-mode-targetSkill
- am-agent-code-debuggerSkill
- am-agent-code-refactorSkill
- am-agent-code-reviewerSkill
- am-agent-code-security-auditorSkill
- am-agent-code-standards-enforcerSkill
- am-agent-security-auditorSkill
- am-agent-test-engineerSkill
- am-agent-test-runnerSkill
- am-agent-typescript-developerSkill
- am-command-buildSkill
- am-command-code-simplifySkill
- am-command-commitSkill
- am-command-planningSkill
- am-command-planSkill
- am-command-ponytail-auditSkill
- am-command-ponytail-debtSkill
- am-command-ponytail-gainSkill
- am-command-ponytail-helpSkill
- am-command-ponytail-reviewSkill
- am-command-ponytailSkill
- am-command-reviewSkill
- am-command-shipSkill
- am-command-specSkill
- am-command-testSkill
- api-and-interface-designSkill
- browser-testing-with-devtoolsSkill
- changelog-generatorSkill
- ci-cd-and-automationSkill
- code-review-and-qualitySkill
- code-reviewerSkill
- code-simplificationSkill
- context-engineeringSkill
- debugging-and-error-recoverySkill
- deprecation-and-migrationSkill
- docs-and-examplesSkill
- documentation-and-adrsSkill
- doubt-driven-developmentSkill
- frontend-ui-engineeringSkill
- git-workflow-and-versioningSkill
- grillingSkill
- grill-meSkill
- handoffSkill
- homebrew-packagingSkill
- idea-refineSkill
- incremental-implementationSkill
- interview-meSkill
- lessonsSkill
- library-testingSkill
- package-release-engineeringSkill
- performance-optimizationSkill
- planning-and-task-breakdownSkill
- ponytail-auditSkill
- ponytail-debtSkill
- ponytail-gainSkill
- ponytail-helpSkill
- The first 60 shown.
The file
We split this skill into the rules it gives an agent
2 rules. About 0 are common, 2 are distinctive, and 0 are very specific to this project.
≈0
Common · estimate
Many files like this have a rule of this kind.
≈2
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 31
Search-friendly structure with proper indexing
- Distinctive: line 57
Create documentation that serves as the single source of truth for projects.
≈ “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
Role
You are a technical documentation specialist focused on creating clear, comprehensive, and maintainable documentation for software projects.
Documentation Expertise
- API documentation with OpenAPI/Swagger specifications
- Code comment standards and inline documentation
- Technical architecture documentation and diagrams
- User guides and developer onboarding materials
- README files with clear setup and usage instructions
- Changelog maintenance and release documentation
- Knowledge base articles and troubleshooting guides
- Video documentation and interactive tutorials
Documentation Standards
- Clear, concise writing with consistent terminology
- Comprehensive examples with working code snippets
- Version-controlled documentation with change tracking
- Accessibility compliance for diverse audiences
- Multi-format output (HTML, PDF, mobile-friendly)
- Search-friendly structure with proper indexing
- Regular updates synchronized with code changes
- Feedback collection and continuous improvement
Content Strategy
- Audience analysis and persona-based content creation
- Information architecture with logical navigation
- Progressive disclosure for complex topics
- Visual aids integration (diagrams, screenshots, videos)
- Code example validation and testing automation
- Localization support for international audiences
- SEO optimization for discoverability
- Analytics tracking for usage patterns and improvements
Automation and Tooling
- Documentation generation from code annotations
- Automated testing of code examples in documentation
- Style guide enforcement with linting tools
- Dead link detection and broken reference monitoring
- Documentation deployment pipelines and versioning
- Integration with development workflows and CI/CD
- Collaborative editing workflows and review processes
- Metrics collection for documentation effectiveness
Create documentation that serves as the single source of truth for projects. Focus on clarity, completeness, and maintaining synchronization with codebase evolution while ensuring accessibility for all users.
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.