create-project-docs

Generate a complete GitHub documentation suite from codebase analysis.

Updated Aug 23, 2026
One-click install
npx skills add https://github.com/caioniehues/dotfiles --skill create-project-docs
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: create-project-docs
Source: https://github.com/caioniehues/dotfiles/tree/main/skills/create-project-docs
Command: npx skills add https://github.com/caioniehues/dotfiles --skill create-project-docs

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes references (resource) components.

What problem does it solve?

This Skill creates a comprehensive GitHub project documentation suite by analyzing the codebase and generating essential docs such as README, CONTRIBUTING, CODE_OF_CONDUCT, CHANGELOG, architecture docs, and API documentation, all styled to modern GitHub conventions.

Core Features & Use Cases

  • Codebase analysis: Inspect project structure, entry points, and public API surface.
  • Documentation generation: Produce README, CONTRIBUTING, CODE_OF_CONDUCT, CHANGELOG, architecture docs, and API docs.
  • Styling and validation: Apply GitHub-friendly badges, table of contents, collapsible sections, and consistent headings.

Quick Start

Run the documentation workflow to generate the full documentation suite for the current repository.

Frequently Asked Questions about create-project-docs

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I generate GitHub documentation from my codebase?

Generate complete GitHub documentation by analyzing your project structure, entry points, and APIs to automatically create README, CONTRIBUTING, CODE_OF_CONDUCT, CHANGELOG, architecture docs, and API documentation styled for GitHub conventions.

What documentation files does this Skill create?

This Skill generates a full documentation suite: README with table of contents and badges, CONTRIBUTING guidelines, CODE_OF_CONDUCT, CHANGELOG tracking changes, architecture documentation explaining project structure, and API documentation detailing public interfaces.

Can I use this Skill to update existing project documentation?

Yes, this Skill regenerates missing or outdated documentation sections across your entire GitHub repository, making it suitable for improving existing documentation or creating documentation from scratch for new projects.

Does this Skill analyze the actual source code to generate docs?

The Skill inspects project structure, entry points, public API surface, and reads manifests to infer your architecture and interfaces, then generates documentation that accurately reflects your codebase.

What makes the generated documentation GitHub-compliant?

Generated docs apply GitHub-friendly styling including badges, table of contents, collapsible sections, and consistent heading structures that meet modern GitHub documentation conventions.

Do I need specific dependencies or setup to run this documentation workflow?

This Skill has no external dependencies and works with any codebase by analyzing existing source files and project manifests, requiring only read access to your repository structure.