doc-writer

To generate project documentation, you need to provide a documented style guide, a README index, and access to source code. The skill uses these inputs to produce standardized docs that ensure consistency and clarity across all modules.

Creating contributor guidelines requires access to your source code and existing design notes. The skill generates contribution-ready guidelines that streamline collaboration and standardize documentation structure across your team.

Maintaining and indexing API references is handled through automated structure and indexing features. This keeps your documentation navigable and up-to-date by organizing API references and design specs under a README index.

Yes, a README index is required to automate documentation generation. Along with a documented style guide and source code access, the README index ensures the output remains accurate and navigable across modules.

Yes, you can use standardized templates for common docs including user guides and contribution guidelines. The skill provides these templates to reduce confusion and improve maintainability across various workflows.

Automated documentation generation is not suitable when you lack a documented style guide, a README index, or access to source code. Without these inputs, the tool cannot produce accurate, up-to-date docs for your project.