‹ 首页

code-docs

@martinffx · 收录于 1 周前

Documentation generation for code projects. Use when updating docs, writing README, generating API docs, creating changelog, or when the user mentions documentation, docs, readme, api docs, or any documentation task.

场景代码文档readme编写api文档生成

适合你，如果经常需要为代码项目编写或更新文档

/ 下载安装
code-docs.skill双击,或拖进 Claude 桌面版 / Cowork,即完成安装↓ .skill↓ .zip
用别的 agent?下载 .zip 解压,把文件夹放进它的技能目录
Claude Code~/.claude/skills/(项目级 .claude/skills/)
Codex CLI~/.codex/skills/
Cursor自动读取上面两处目录
其他工具见其文档的「skills」目录;两个下载是同一份文件,只是名字不同
/ 通过 npx 安装 校验哈希
npx oh-my-skill add martinffx/atelier/code-docs
/ 通过 bash 安装
curl -fsSL https://oh-my-skill.com/install.sh | bash -s -- martinffx/atelier/code-docs
/ 已经装过?验证本机副本,不用重装
npx oh-my-skill verify martinffx/atelier/code-docs
安装目标可用 --agent / --scope 或 --to 明确指定;省略时只会在唯一已存在的 agent 目录上自动选择,零命中或多命中会停止并提示。content_hash 缺失或不一致均拒装。
34GitHub stars
~536最小装载
~1.4K含声明引用
~1.4K文本包总量
镜像托管

怎么用

技能原文 SKILL.md作者撰写 · MIT · e5f96ba

Code Docs

Documentation generation and maintenance for code projects.

When to Document

Always update docs when:

  • Adding new features
  • Changing existing behavior
  • Updating configuration
  • Breaking changes

Docs should live:

  • Near the code (docstrings, comments)
  • In the repo (README, docs folder)
  • Generated (API docs, type docs)
Doc Types
README

Project overview, setup, usage. See references/readme-structure.md

Template:

# Project Name

Brief description (one line).

## Quick Start

3-5 commands to get running.

## Installation

Detailed setup steps.

## Usage

Code examples.

## API

Link to full API docs.

## Contributing

How to contribute.

## License
API Documentation

See references/api-docs.md for:

  • TypeDoc (JavaScript/TypeScript)
  • Sphinx (Python)
  • godoc (Go)
  • JSDoc (JavaScript)
Changelog

See references/changelog.md for Keep a Changelog format.

Sections:

  • Added
  • Changed
  • Deprecated
  • Removed
  • Fixed
  • Security
Architecture Docs

See references/architecture-docs.md for:

  • ADRs (Architecture Decision Records)
  • Diagrams
  • System overviews
Generation Commands
TypeScript/JavaScript
# TypeDoc
npx typedoc --out docs src/index.ts

# JSDoc
npx jsdoc src/ -d docs/

# API Extractor (monorepos)
npx api-extractor run
Python
# Sphinx
sphinx-build -b html docs docs/_build

# pdoc
pdoc --output-dir docs src/

# mkdocs
mkdocs serve
Go
# godoc
godoc -http=:6060

# swag (OpenAPI from comments)
swag init -g cmd/server/main.go
Workflow
1. Identify what needs docs
  • New files/features → update relevant doc
  • Breaking change → update CHANGELOG
  • New public API → update API docs
2. Generate/Update
  • Run doc generators
  • Update manual docs
  • Verify examples work
3. Verify
  • Links work
  • Examples run
  • Build passes
4. Commit
docs: update API documentation

Generated via typedoc.
Added: new /users endpoint
Changed: authentication section
Best Practices
  1. Write docs in the code - Docstrings, comments
  2. Generate where possible - Don't duplicate
  3. Keep README minimal - Link to detailed docs
  4. Version with code - Docs in same repo/PR
  5. Test examples - Ensure they run
按 MIT 许可原样转载,未经改动 · 在 GitHub 查看 →

评论

登录即可评论;带「已验证安装」的,是发布者名下有本店的安装或持有记录。
…