skills.rest
jjmartres
jjmartresCOMMUNITY
Explore all skills by this author →
GitHub

project-docs

Generate README, ARCHITECTURE, USER_GUIDE, DEVELOPER_GUIDE, and CONTRIBUTING files for Python and Go projects.

40|4|Updated Apr 19, 2026
Search Tags:#architecture#templates#documentation#readme#docs#developer-guide
One-click install
npx skills add https://github.com/jjmartres/ai-coding-agents --skill project-docs-jjmartres
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: project-docs
Source: https://github.com/jjmartres/ai-coding-agents/tree/main/shared/.ai-agents/skills/project-docs
Command: npx skills add https://github.com/jjmartres/ai-coding-agents --skill project-docs-jjmartres

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Generate comprehensive, professional project documentation structures (README, ARCHITECTURE, USER_GUIDE, DEVELOPER_GUIDE, CONTRIBUTING) automatically, saving time and ensuring consistency across repos.

Core Features & Use Cases

  • Automatically creates the five core docs for new projects
  • Adapts content to Python/Go projects and to OpenSource or internal contexts
  • Produces a ready-to-publish, templated documentation suite with guidance and examples

Quick Start

Provide a repository URL and ask to generate a complete documentation suite.

Frequently Asked Questions about project-docs

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

FAQPage Schema
How do I generate a complete project documentation set for a Python or Go repository?▼

You can generate a complete project documentation set by providing a repository URL. The Skill auto-creates README, ARCHITECTURE, USER_GUIDE, DEVELOPER_GUIDE, and CONTRIBUTING files tailored to Python or Go projects.

What is the best way to create an open source README and developer guide automatically?▼

The best way to create open source documentation automatically is using a Skill that adapts to your project context. It generates a ready-to-publish README and developer guide with consistent formatting and runnable examples.

Can I customize the architecture documentation for internal versus open source contexts?▼

Yes, you can generate architecture documentation tailored for either internal or open source contexts. The Skill adapts the content of your ARCHITECTURE.md and other docs based on the project's specific publishing context.

Does this documentation generator work with existing repository structures and files?▼

Yes, the documentation generator adapts to existing repository structures and file presence. It ensures the newly created documentation suite integrates coherently without overwriting your current project files.

What files are included in a standard developer documentation suite?▼

A standard developer documentation suite includes README.md, ARCHITECTURE.md, USER_GUIDE.md, DEVELOPER_GUIDE.md, and CONTRIBUTING.md. These five core files provide comprehensive coverage for users, developers, and contributors.

Related Skills

Explore More Content & Communication Skills→
oiiiwjhoiiiwjh
4

update-readme

Automates README.md and AGENTS.md updates from Git history and project structure using Python scripts.

Community
Intermediate
windyskywindysky

moai-docs-generation

Generate documentation patterns from code for Sphinx, MkDocs, TypeDoc, and Nextra.

Community
Advanced
opensage-agentopensage-agent
113

get-caller

Identify direct and indirect callers of functions using Neo4j callgraph data.

Official
Intermediate
JongsixJongsix

moai-docs-generation

Generate technical documentation from source code and API definitions.

Community
Advanced