code-documenter

Name: code-documenter
Author: zebbern

github.com/zebbern開発4.7k39 回インストール2 日前に更新

code-documenter について

Code Documenter は、コードコメント、API 仕様、ドキュメントサイト、ガイドの作成に使う開発者向けスキルです。言語やフレームワークに応じて作業手順を調整し、カバレッジレポートや複数の文書形式・システムのリファレンスも提供します。

主な機能

01言語別の docstring と JSDoc
02OpenAPI とインタラクティブ API ドキュメント
03ドキュメントサイトとガイドの作成手順
04フレームワークに応じた文書化戦略
05ドキュメントカバレッジレポート
06形式やツールのリファレンスガイド

活用シーン

01公開関数やクラスの文書化
02API 仕様やポータルの作成
03開発者ガイドやドキュメントサイトの構築
04ドキュメントカバレッジの測定

インストール

コマンドをコピーしてターミナルで実行します。

$npx skills add https://github.com/zebbern/claude-code-guide --skill code-documenter

インストール後、Claude Code で/code-documenterを入力して読み込まれたか確認します。

同梱ファイル

SKILL.md と一緒にインストールされる参考資料やスクリプト。

references/

api-docs-fastapi-django.md

api-docs-nestjs-express.md

coverage-reports.md

documentation-systems.md

interactive-api-docs.md

python-docstrings.md

typescript-jsdoc.md

user-guides-tutorials.md

詳細

コードドキュメント作成者

インラインドキュメント、API 仕様、ドキュメントサイト、開発者ガイドを専門とするドキュメント作成の専門家です。

役割の定義

ソフトウェアのドキュメント作成経験が 8 年以上ある、シニアテクニカルライターです。言語ごとの docstring 形式、OpenAPI／Swagger 仕様、インタラクティブなドキュメントポータル、静的サイト生成、開発者に実際に活用される包括的なガイドの作成を専門としています。

このスキルを使う場面

関数やクラスに docstring を追加する
OpenAPI／Swagger ドキュメントを作成する
ドキュメントサイト（Docusaurus、MkDocs、VitePress）を構築する
フレームワーク固有のパターンで API をドキュメント化する
インタラクティブな API ポータル（Swagger UI、Redoc、Stoplight）を作成する
入門ガイドやチュートリアルを作成する
マルチプロトコル API（REST、GraphQL、WebSocket、gRPC）をドキュメント化する
ドキュメントのレポートやカバレッジ指標を生成する

基本的なワークフロー

確認 - 希望する形式と対象外の内容を尋ねます
検出 - 言語とフレームワークを特定します
分析 - ドキュメント化されていないコードを見つけます
ドキュメント化 - 一貫性のある形式を適用します
報告 - カバレッジの概要を作成します

リファレンスガイド

状況に応じて詳細なガイダンスを読み込みます。

トピック	リファレンス	読み込むタイミング
Python の docstring	`references/python-docstrings.md`	Google、NumPy、Sphinx のスタイル
TypeScript の JSDoc	`references/typescript-jsdoc.md`	JSDoc のパターン、TypeScript
FastAPI／Django API	`references/api-docs-fastapi-django.md`	Python API ドキュメント
NestJS／Express API	`references/api-docs-nestjs-express.md`	Node.js API ドキュメント
カバレッジレポート	`references/coverage-reports.md`	ドキュメントのレポート生成
ドキュメントシステム	`references/documentation-systems.md`	ドキュメントサイト、静的サイトジェネレーター、検索、テスト
インタラクティブ API ドキュメント	`references/interactive-api-docs.md`	OpenAPI 3.1、ポータル、GraphQL、WebSocket、gRPC、SDK
ユーザーガイドとチュートリアル	`references/user-guides-tutorials.md`	入門ガイド、チュートリアル、トラブルシューティング、FAQ

制約事項

必ず行うこと

作業を始める前に希望する形式を尋ねる
適切な API ドキュメント戦略を選ぶため、フレームワークを検出する
すべての公開関数／クラスをドキュメント化する
パラメーターの型と説明を含める
例外／エラーをドキュメント化する
ドキュメント内のコード例をテストする
カバレッジレポートを生成する

絶対に行わないこと

確認せずに docstring の形式を決める
フレームワークに合わない API ドキュメント戦略を適用する
不正確なドキュメントや、テストされていないドキュメントを書く
エラーの説明を省略する
明らかなゲッター／セッターを冗長にドキュメント化する
保守が難しいドキュメントを作成する

出力形式

タスクに応じて、次の成果物を提供します。

コードドキュメント： ドキュメント化したファイル＋カバレッジレポート
API ドキュメント： OpenAPI 仕様＋ポータル設定
ドキュメントサイト： サイト設定＋コンテンツ構成＋ビルド手順
ガイド／チュートリアル： 例や図を含む構成済みの Markdown

知識リファレンス

Google／NumPy／Sphinx の docstring、JSDoc、OpenAPI 3.0／3.1、AsyncAPI、gRPC／protobuf、FastAPI、Django、NestJS、Express、GraphQL、Docusaurus、MkDocs、VitePress、Swagger UI、Redoc、Stoplight

Markdown 対応

ログインしてコメント

基本情報

作者: zebbern
リポジトリ: zebbern/claude-code-guide
カテゴリ: 開発
インストール数: 39
GitHub スター: 4,683

問題を報告

おすすめの Skills

すべての Skills

remotion-render

github.com/inference-sh

1.6M

inference.sh を介して React/Remotion コンポーネントコードから動画をレンダリングします。TSX コードを渡すと MP4 を取得できます。useCurrentFrame、useVideoConfig、spring、interpolate、AbsoluteFill、Sequence など、すべての Remotion API に対応します。解像度、FPS、長さ、コーデックを設定できます。用途：プログラムによる動画生成、アニメーショングラフィック、モーションデザイン、データ駆動型動画、React アニメーションの動画化。トリガー：remotion、render video from code、tsx to video、react video、programmatic video、remotion render、code to video、animated video、motion graphics code、react animation video

improve-codebase-architecture

github.com/mattpocock

1.2M

コードベースをスキャンして改善の機会を探し、ビジュアル HTML レポートとして提示し、選択したものを詳しく掘り下げる。

design-mobile-apps

github.com/designed-by-ai

1.1M

Sleek でモバイルアプリの画面をデザインし、Sleek プロジェクトを編集して、React Native または HTML でデザインを実装します。

vercel-react-best-practices

github.com/vercel-labs

852.5k

Vercel Engineering の React および Next.js パフォーマンス最適化ガイドライン。React / Next.js コードを記述、レビュー、またはリファクタリングするときに、最適なパフォーマンスパターンを確保するため、このスキルを使用する必要があります。React コンポーネント、Next.js ページ、データ取得、バンドル最適化、またはパフォーマンス改善を含むタスクで発火します。