am-agent-code-documenter
- Repo stars 15
- Author updated Live
- Author repo agentsmesh
- Domain
- Documentation
- Compatible agents
-
- Claude Code
- Cursor
- Cline
- Codex
- Windsurf
- Gemini CLI
- +20
- Trust score
- 88 / 100 · community maintained
- Author / version / license
- @sampleXbro · no license declared
- Token usage
- Lean
- Setup complexity
- Plug-and-play
- External API key
- Not required
- Operating systems
- Unspecified (assume cross-platform)
- Runtime requirements
- No special requirements
- Permissions
-
- Read-only
- Write / modify
- Network behavior
- Local-only
- Install commands
- 26 variants
Profile is derived at build time from SKILL.md and install vectors. Subject to drift from author intent.
Heads up: 未限定 allowed-tools,默认拥有全部工具权限。
---
name: am-agent-code-documenter
description: Create comprehensive technical documentation, API docs, and inline code comments. Specializes in…
category: documentation
runtime: no special runtime
---
# am-agent-code-documenter output preview
## PART A: Task fit
- Use case: 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..
- Inputs: target material, constraints, expected output, and acceptance criteria.
- Evidence boundary: follow “Role / Documentation Expertise / Documentation Standards” and do not present inference as author intent.
## PART B: Execution result
- **01** The card summarizes the use case; runtime output centers on “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.”.
- **02** When the source has headings, the agent prioritizes “Role / Documentation Expertise / Documentation Standards” so the result follows the author’s structure.
- **03** Typical output includes task judgment, concrete steps, required commands or file edits, validation, and follow-up options.
- **04** Risk context follows the fingerprint: read files, write/modify files; mostly runs locally; usually needs no extra API key.
## Running Rules
- read files, write/modify files; mostly runs locally; usually needs no extra API key.
- Validate with a small sample before expanding scope.
- Return the result, validation criteria, and next iteration options. The source does not require a stable slash command. After installation, invoke the skill by name and describe the task.
Name target files or source material, expected output, forbidden changes, and whether network or shell access is allowed. Permission fingerprint: read files, write/modify files.
Start with a small task and check whether the result follows “Role / Documentation Expertise / Documentation Standards”. Inspect diffs, logs, previews, or tests before expanding scope.
Confirm the final output includes a concrete result, evidence, and next action. If it stays generic, tighten inputs, boundaries, and acceptance criteria.
---
name: am-agent-code-documenter
description: Create comprehensive technical documentation, API docs, and inline code comments. Specializes in…
category: documentation
source: sampleXbro/agentsmesh
---
# am-agent-code-documenter
## When to use
- Create comprehensive technical documentation, API docs, and inline code comments. Specializes in documentation generat…
- Use it when the task has clear inputs, repeatable steps, and validation criteria.
## What to provide
- Target material, scope, expected result, and forbidden changes.
- Whether network, commands, file writes, or external services are allowed.
## Execution rules
- Organize steps around “Role / Documentation Expertise / Documentation Standards” and keep inference separate from source facts.
- read files, write/modify files; mostly runs locally; usually needs no extra API key.
- Validate with a small sample before expanding the task.
## Output requirements
- Return the deliverable, key evidence, validation method, and next action.
- Mark missing information as unknown; do not invent commands, platforms, or dependencies. The author source anchors workflow facts; repository files anchor sources and commands; Fluxly only adds fit, limitations, and quality judgment.
skill "am-agent-code-documenter" {
input -> user goal + target files + boundaries + acceptance criteria
context -> Role / Documentation Expertise / Documentation Standards
rules -> SKILL.md triggers / order / output contract
runtime -> no special runtime | read files, write/modify files | mostly runs locally
guardrails -> usually needs no extra API key + small-sample validation + diff/log review
output -> copyable result + checklist + next iteration
} 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.
Decide Fit First
Design Intent
How To Use It
Boundaries And Review