New: 98,000+ skills indexed from GitHub repos with 100+ stars · every skill safety-checkedBrowse top skillsTop skills
Esc to closeBrowse all skills
Submit a skillBrowse skills
Submit a skillBrowse skills

Agent skill

Project Docs

by jjmartres in jjmartres/opencode

Generate comprehensive, professional project documentation structures including README, ARCHITECTURE, USERGUIDE, DEVELOPERGUIDE, and CONTRIBUTING files.

MITAuto-check passedDevelopment

Install Project Docs

skills CLI
$ npx skills add jjmartres/opencode --skill project-docs -a claude-code

Project install by default; add -g for ~/.claude/skills/.

GitHub CLI
$ gh skill install jjmartres/opencode project-docs --agent claude-code

Project scope by default; add --scope user for a personal install. Needs GitHub CLI 2.90.0 or later (public preview).

Manual copy
$ git clone --depth 1 https://github.com/jjmartres/opencode.git skills-src && mkdir -p .claude/skills && cp -r skills-src/opencode/skills/project-docs .claude/skills/project-docs && rm -rf skills-src

Use ~/.claude/skills/ instead of .claude/skills for a personal install. The folder must contain SKILL.md.

Claude Code skills documentation · loads skills from .claude/skills/

Facts

Skill name
project-docs
GitHub stars
133
Token cost
~1.3k tokens
SKILL.md length
550 words
Files
2 (incl. references)
Skills in repo
11
Repo updated
First seen
Licence
MIT

At a glance

Generate comprehensive, professional project documentation structures including README, ARCHITECTURE, USERGUIDE, DEVELOPERGUIDE, and CONTRIBUTING files.

  • Works in 7 steps: Context Detection → Ask Clarifying Questions → Content Adaptation → …
  • The user requests project documentation creation
  • SKILL.md covers Core Documentation Files, Workflow, Resources and Special Considerations, plus 2 more sections
  • Instructions only: no scripts, shell commands, URLs or credentials in SKILL.md

What it does

Project Docs is an agent skill from jjmartres/opencode. Generate comprehensive, professional project documentation structures including README, ARCHITECTURE, USERGUIDE, DEVELOPERGUIDE, and CONTRIBUTING files. Use when the user requests project documentation creation, asks to "document a project", needs standard documentation files, or wants to set up docs for a new repository. Adapts to Python/Go projects and OpenSource/internal contexts.

Its SKILL.md is about 1.3k tokens, which your agent loads only when the skill is triggered. The skill folder holds 2 other files, including reference files (for example `references/template.md`).

It sits in Development, covering Technical writing and Technical documentation. It works with Python. The repository describes itself as: A powerful, custom opencode configuration, complete with a suite of agents, commands, rules, skills, and a pre-configured MCP server. It's designed to be a flexible starting… The licence is MIT.

When your agent uses it

  • The user requests project documentation creation
  • Asks to document a project
  • Needs standard documentation files
  • Wants to set up docs for a new repository

Example prompts

  • “document a project”
  • “/project-docs”

Requirements

  • Python 3

Workflow steps

7 steps, taken from the step headings in SKILL.md.

  1. Context Detection
  2. Ask Clarifying Questions
  3. Content Adaptation
  4. File Generation
  5. Template Application
  6. Quality Checks
  7. Output

What it can do on your machine

Read from SKILL.md and the folder at commit 28dc323. It shows what the files ask for, not the result of running them.

  • Tool permissions

    Pre-approves nothing: there is no allowed-tools line, so your agent's usual permission prompts apply.

    From allowed-tools in the SKILL.md frontmatter.

  • Runs code

    No scripts in the folder and no shell commands in SKILL.md.

    From the folder's file list and the shell code blocks in SKILL.md.

  • Network

    No URLs in SKILL.md.

    From URLs in SKILL.md, links to its own repository left out.

  • Credentials

    Names no API keys, tokens, secrets or passwords.

    From names ending in _API_KEY, _TOKEN, _SECRET, _KEY or _PASSWORD in SKILL.md.

Context cost

Project Docs loads about 1.3k tokens when it runs, and up to ~8.9k if it reads all its reference files. Until then it costs about 100 tokens; SKILL.md has 550 words of instructions outside code blocks.

Always · name and description, kept in context so the agent knows when to use it
~100
When it runs · the whole SKILL.md, loaded when a task matches
~1.3k
With references · SKILL.md plus every file in references/, read only if the agent opens them
~8.9k

Estimates: characters ÷ 4, the usual rule of thumb; real counts depend on the model's tokenizer. Scripts and assets cost tokens only if the agent reads them.

Safety

Auto-check passed

The automated check found no risky patterns in SKILL.md.

Automated static check — not a guarantee. Review scripts before installing. It scans the text of SKILL.md for risky patterns (piping downloads into a shell, reading credential files, hidden Unicode, destructive commands); files beside SKILL.md are not scanned.

SKILL.md

The full file from jjmartres/opencode at commit 28dc323, republished under its MIT licence (© jjmartres). 550 words, ~1,288 tokens.

Download SKILL.mdSave it as .claude/skills/project-docs/SKILL.md (or your agent's skills folder). This skill also uses 1 other file; get the full folder from GitHub.
name
project-docs
description
Generate comprehensive, professional project documentation structures including README, ARCHITECTURE, USER_GUIDE, DEVELOPER_GUIDE, and CONTRIBUTING files. Use when the user requests project documentation creation, asks to "document a project", needs standard documentation files, or wants to set up docs for a new repository. Adapts to Python/Go projects and OpenSource/internal contexts.

Project Documentation Generator

Generate complete, professional documentation structures for software projects. Automatically adapts content and structure based on project language (Python/Go), context (OpenSource/internal), and existing files.

Core Documentation Files

Always generate these five core files:

  1. README.md - Project overview, quick start, badges
  2. ARCHITECTURE.md - System design, components, data flow
  3. USER_GUIDE.md - Usage examples, configuration, troubleshooting
  4. DEVELOPER_GUIDE.md - Development setup, testing, contribution workflow
  5. CONTRIBUTING.md - Contribution guidelines, code standards, PR process

Workflow

1. Context Detection

Before generating docs, detect:

  • Language: Scan for go.mod, pyproject.toml, requirements.txt, setup.py
  • Project type: Check for Dockerfile, terraform/, k8s/, AI/ML indicators
  • Existing docs: Identify what already exists to avoid duplication
  • License: Detect from LICENSE file or ask user
  • Context: Determine if OpenSource or internal based on repo structure
2. Ask Clarifying Questions

Ask user ONE question at a time to fill gaps:

  • "What's the primary purpose of this project in one sentence?"
  • "Who's the main audience? (developers, ops, end-users, all)"
  • "Is this OpenSource or internal? (affects badges, contact info)"
  • "Any company-specific tooling to mention? (Jira, Slack channels, etc.)"
3. Content Adaptation

Read references/templates.md to select appropriate template variants based on detected context.

Language-specific elements:

  • Python: Package managers (uv, pip, poetry), testing (pytest), linting (ruff, mypy)
  • Go: Build commands, testing, golangci-lint, module structure

Context-specific elements:

  • OpenSource: Badges, CODE_OF_CONDUCT, security policy, community guidelines
  • Internal: Slack channels, internal tools, compliance requirements, team contacts

Project type adjustments:

  • AI Agents: MCP architecture, prompt patterns, example interactions
  • Infrastructure: Terraform/K8s setup, deployment procedures, DR plans
  • Microservices: API schemas, service mesh, health checks
  • CLI Tools: Installation methods, command examples, flags
4. File Generation

Generate files in this order:

  1. README.md first (most visible, sets tone)
  2. ARCHITECTURE.md (technical foundation)
  3. DEVELOPER_GUIDE.md (setup and contribution)
  4. USER_GUIDE.md (end-user focused)
  5. CONTRIBUTING.md (community guidelines)

Each file must:

  • Use clear headers and structure from templates
  • Include concrete, runnable examples
  • Reference other docs when needed (avoid duplication)
  • Match project's actual structure and commands
5. Template Application

For each file:

  1. Select template variant from references/templates.md
  2. Fill in project-specific details
  3. Add context-appropriate sections
  4. Ensure consistency across all files
Show full SKILL.md (209 more words)Show less
6. Quality Checks

Before finalizing, verify:

  • All code examples are runnable and accurate
  • Commands match detected language/tooling
  • Cross-references between docs are correct
  • No placeholder text remains
  • Tone is consistent (technical/friendly/formal based on context)
7. Output

Place all files in docs/ and use present_files to share with user.

Resources

references/templates.md

Contains complete documentation templates for all five core files with variants for:

  • Python vs Go projects
  • OpenSource vs internal contexts
  • Different project types (agent, service, CLI, infra)
  • Different complexity levels

Claude should read this file to select appropriate templates before generating docs.

Special Considerations

For AI Agent projects:

  • Explain MCP server architecture
  • Document tool integrations
  • Show example prompts and interactions
  • Include LLM configuration details

For Infrastructure/DevOps:

  • Environment requirements (cloud providers, versions)
  • Deployment runbooks
  • Monitoring setup
  • Disaster recovery procedures

For Microservices:

  • API endpoint documentation
  • Service dependency diagrams
  • Inter-service communication patterns
  • Health check and metrics endpoints

Quality Standards

Every documentation file must:

  • Have table of contents for files >200 lines
  • Use proper code fences with language tags
  • Include "Quick Start" section at top
  • Show real, tested examples
  • Explain "why" decisions were made
  • Use consistent terminology throughout

Avoid

  • Generic placeholder text like "TODO" or "Coming soon"
  • Outdated technology references
  • Overly complex explanations without examples
  • Duplicating content across multiple files
  • Missing concrete code examples

© jjmartres, MIT. Rendered from Markdown: HTML in the file is shown as text, images as links, and headings moved down two levels. Raw file

Files

SKILL.md and 1 other file (references) in opencode/skills/project-docs of jjmartres/opencode.

  • SKILL.md
  • references/template.md

Open the folder on GitHubat commit 28dc323

Compare with similar skills

Project Docs next to the 5 skills that share the most tags, products or categories with it. Stars are the repository's; “used in” counts other GitHub owners with a copy.

Project Docs compared with similar skills
SkillStarsUsed inTokensAuto-checkLicenceRepo updated
Project Docs this skilljjmartres/opencode133—~1.3kAutomated safety check: PassMIT
Diataxis Docs Writercalf-ai/calfkit-sdk1491 repos~3kAutomated safety check: PassApache-2.0
Docsbrickbots/PiFinder250—~6.2kAutomated safety check: PassGPL-3.0
Updating Docs For Releasestreamlit/docs178—~4kAutomated safety check: PassApache-2.0
Technical Writingrsmdt/the-startup551—~1.3kAutomated safety check: PassMIT
Technical Writerfinos/morphir213—~4.4kAutomated safety check: PassApache-2.0

Similar skills

  • Diataxis Docs Writer

    calf-ai/calfkit-sdk

    Write or improve software documentation using the Diátaxis framework — four documentation types (tutorials, how-to guides, reference, explanation), each serving a different user need.

    149 GitHub starsUsed in 1 repo~3k tokens
    DevelopmentAuto-check passed

  • Docs

    brickbots/PiFinder

    Author and edit PiFinder's user-facing documentation in the project's house style.

    250 GitHub stars~6.2k tokensUpdated yesterday
    DevelopmentAuto-check passed

  • Updating Docs For Release

    streamlit/docs

    Update the streamlit/docs repo for a new Streamlit release. An agent skill from streamlit/docs.

    178 GitHub stars~4k tokensUpdated yesterday
    DevelopmentAuto-check passed

  • Technical Writing

    rsmdt/the-startup

    Create architectural decision records (ADRs), system documentation, API documentation, and operational runbooks.

    551 GitHub stars~1.3k tokensUpdated 2 mo ago
    DevelopmentAuto-check passed

  • Technical Writer

    finos/morphir

    Assists with writing and maintaining Morphir technical documentation.

    213 GitHub stars~4.4k tokensUpdated today
    DevelopmentAuto-check passed

  • Kitaru Docs

    zenml-io/kitaru

    Kitaru documentation surfaces, link rules, and accuracy rules.

    301 GitHub stars~936 tokensUpdated yesterday
    DevelopmentAuto-check passed

More from jjmartres/opencode

All 11 skills in this repo

  • Mermaid Diagrams

    jjmartres/opencode

    Helps an agent pick the right Mermaid diagram type and write the syntax for class, sequence, flow, ER, C4, state and other software diagrams.

    133 GitHub starsUsed in 6 repos~1.9k tokens
    Auto-check passed

  • Marp Slide Creator

    jjmartres/opencode

    Builds Marp slide decks in one of seven ready-made themes, using bundled templates plus syntax, image and style references to keep slides short and readable.

    133 GitHub starsUsed in 3 repos~2.2k tokens
    Auto-check passed

  • Jira Natural Language Interface

    jjmartres/opencode

    Lets an agent view, create, update and transition Jira issues in natural language, automatically choosing between the jira CLI and Atlassian MCP tools.

    133 GitHub starsUsed in 3 repos~1.7k tokens
    Auto-check passed

  • Google Style Code Docs

    jjmartres/opencode

    Applies Google Style documentation to Python docstrings, Go comments and Terraform descriptions, for writing new docs or reviewing existing ones.

    133 GitHub stars~1.9k tokensUpdated 5 mo ago
    Auto-check passed

  • Asdf

    jjmartres/opencode

    A skill your agent uses whenever the user wants to install, configure, or use asdf (asdf-vm), the universal version manager.

    133 GitHub starsUsed in 1 repo~2.1k tokens
    Auto-check: notes

  • Worktrunk Git Worktree Manager

    jjmartres/opencode

    Guides use of Worktrunk (wt), a CLI that makes git worktrees as easy as branches so several AI agents can work in parallel on isolated branches.

    133 GitHub stars~1.9k tokensUpdated 5 mo ago
    Auto-check: notes

Works with

Categories

Questions about Project Docs

What does Project Docs do?

Generate comprehensive, professional project documentation structures including README, ARCHITECTURE, USERGUIDE, DEVELOPERGUIDE, and CONTRIBUTING files. Project Docs is an agent skill from jjmartres/opencode. Generate comprehensive, professional project documentation structures including README, ARCHITECTURE, USERGUIDE, DEVELOPERGUIDE, and CONTRIBUTING files.

When should I use Project Docs?

Project Docs fits situations like: the user requests project documentation creation; asks to document a project; needs standard documentation files; wants to set up docs for a new repository.

How do I install Project Docs in Claude Code?

Run `npx skills add jjmartres/opencode --skill project-docs -a claude-code`. Or copy the skill folder (opencode/skills/project-docs in jjmartres/opencode) into .claude/skills/project-docs in your project. Claude Code loads it when a task matches its description.

How do I install Project Docs in Codex?

Run `npx skills add jjmartres/opencode --skill project-docs -a codex`. Or copy the skill folder (opencode/skills/project-docs in jjmartres/opencode) into .agents/skills/project-docs in your project. Codex loads it when a task matches its description.

Can I use Project Docs in Cursor, Gemini CLI or GitHub Copilot?

Cursor, Gemini CLI, GitHub Copilot and OpenCode also load SKILL.md folders. With the skills CLI, run `npx skills add jjmartres/opencode --skill project-docs -a cursor` (or -a gemini-cli, github-copilot or opencode for the others). To copy it by hand, put the folder in .cursor/skills/project-docs, .gemini/skills/project-docs, .github/skills/project-docs and .opencode/skills/project-docs in your project.

What does Project Docs need to run?

SKILL.md names no scripts, command-line tools or credentials: Project Docs is instructions for the agent only. Our summary lists: Python 3.

Does Project Docs access the network?

SKILL.md contains no URLs. Any network use would come from the scripts or tools the agent runs. This is read from the text; nothing was executed.

Is Project Docs safe to install?

Our automated static check of SKILL.md found no risky patterns, such as piping downloads into a shell, reading credential files or hidden Unicode. It is not a guarantee. Review the folder before installing.

What licence does Project Docs use?

Project Docs is published under the MIT licence (the repository's licence). It allows redistribution, so the full SKILL.md is shown on this page.

How many tokens does Project Docs use?

About 1.3k tokens (SKILL.md is roughly 5.2k characters). Agents keep only the skill's name and description in context until a task matches; then they load SKILL.md in full. Its references folder adds about 7.6k tokens, read only when the agent opens those files.

What are the alternatives to Project Docs?

Skills that share tags, products or a category with Project Docs: Diataxis Docs Writer (calf-ai/calfkit-sdk, 149 stars), Docs (brickbots/PiFinder, 250 stars), Updating Docs For Release (streamlit/docs, 178 stars) and Technical Writing (rsmdt/the-startup, 551 stars). The comparison table on this page puts their stars, adoption, token cost, safety result and licence side by side.

Who maintains Project Docs?

jjmartres (a GitHub user) maintains it in jjmartres/opencode, which has 133 GitHub stars. The repository holds 11 skills in this directory. The repository was last updated on April 20, 2026.

Source: jjmartres/opencode on GitHub. Facts on this page come from the repository at the commit we read; the author's words are quoted as theirs.