Doc Author

What it does

The doc-author skill generates documentation from code comments and markdown files. It can automatically create API references, tutorials, and other helpful resources based on existing project materials. This helps developers quickly produce comprehensive documentation without manual effort.

When to use it

• Creating API documentation: Automatically generate reference guides for your software's public APIs.
• Building user manuals: Transform markdown notes into structured user guides and tutorials.
• Documenting internal libraries: Create clear documentation for internal codebases, improving maintainability.
• Automating repetitive tasks: Reduce the time spent manually writing and updating documentation.

Key capabilities

• Generates documentation from code comments
• Processes markdown files
• Creates API references
• Produces tutorials and user guides

Example prompts

• "Generate API documentation for my Python project."
• "Create a tutorial based on these markdown notes: [paste markdown content]"
• "Document the following function: [paste code snippet with comments]"

Tips & gotchas

The quality of generated documentation depends heavily on the clarity and completeness of existing code comments or markdown. Ensure your source material is well-written for optimal results.