documentation

技術ドキュメント設計・レビュー

Diátaxisに基づき、チュートリアル、ハウツー、リファレンス、解説の作成・整理・レビューを支援します。

AIスキル大辞典による日本語要約
品質評価88/100評価確度:十分
人気度(GitHub Star) 100発掘スコア 57
01

このSkillでできること

  • 技術ドキュメントを4種類(チュートリアル、ハウツー、リファレンス、解説)に整理する
  • ユーザーガイド、APIドキュメント、チュートリアルを作成・改善する
  • チュートリアルとハウツーガイドなど、適切な文書タイプを判定する
  • 既存ドキュメントの構成や文書間の連携を見直す
02

使い方

01
STEP 1

利用者の文脈、対象読者、目的を確認してから作成する

02
STEP 2

学習、問題解決、情報参照、概念理解の目的に応じて文書タイプを選ぶ

03
STEP 3

各タイプの構成パターンに沿って内容を整理する

04
STEP 4

文書タイプごとの検証基準で、完成度を確認する

03

Skillのインストール

このGitHubリポジトリにあるSkillを確認し、現在の環境に適した方法でインストールしてください。
インストール後、正常に利用できることを確認し、基本的な使い方も簡潔に説明してください。

Repository:
https://github.com/mcollina/skills
04

このSkillを使うプロンプト例

Skill名を明示すると、意図したSkillを使わせやすくなります。自動発動型では必須とは限りません。

技術ドキュメントをDiátaxisに沿って整理してください。対象読者、目的、現在の構成を確認したうえで、チュートリアル、ハウツー、リファレンス、解説のどれに分類すべきか提案してください。
出力例を見る
文書タイプ:ハウツーガイド
目的:既存のExpressアプリにJWT認証を追加する
構成:目的 → 前提条件 → 手順 → 期待される結果
05

安全性チェック

自動解析による参考情報です。Skillの安全性を保証するものではありません。

外部API通信明確な記述なし
Shellコマンド実行明確な記述なし
ファイル読み取り明確な記述なし
ファイル書き込み明確な記述なし
ネットワークアクセス明確な記述なし
認証情報明確な記述なし
06

関連Skill