project-docs

Generate professional project documentation by using a template-driven skill that detects your Python or Go context and produces the five core docs: README, ARCHITECTURE, USER_GUIDE, DEVELOPER_GUIDE, and CONTRIBUTING. It adapts automatically to your existing files and licenses.

The best way to create a documentation scaffold is to automate generation of the five core markdown files tailored to your open source context. This ensures consistent structure across your README, architecture, user guide, developer guide, and contributing guidelines.

Yes, you can customize the README and developer guide because the generation is context-aware. It adapts to your specific project type, such as AI agents, microservices, CLI tools, or infrastructure, ensuring the documentation fits your exact needs.

Yes, this documentation generation works for internal repositories alongside open source projects. It adjusts the content and tone of the five core documents to match the audience needs and governance requirements of your specific project context.

Maintain consistency across project docs by applying template-driven structure and consistency checks during generation. The templates adapt as your project evolves, ensuring all five core documents remain aligned with your current codebase and context.