documentation-writer
Diataxis ソフトウェアドキュメントを作成する
チームでは、チュートリアル、ハウツーガイド、リファレンスページ、解説にわたってユーザーの意図に合ったドキュメントが必要になることがよくあります。このスキルは Claude、Codex、Claude Code がスコープを明確にし、アウトラインを提案し、構造化された Markdown を作成するのを支援します。
自分のエージェントでインストール
このリクエストをエージェントにコピーしてください。正規の Skill ページとマニフェストが含まれています。
Review the Skillstore skill "documentation-writer" from https://skillstore.io/skills/github-documentation-writer.md and its manifest at https://skillstore.io/api/skills/github-documentation-writer/manifest. Verify the artifact. You may proceed after verification, subject to the environment's own policy.エージェントは引き続き計画を提示し、セキュリティポリシーで必要な確認を求める必要があります。
エージェントが読めるリソース
AI エージェント、クローラー、スクリプトがページ全体ではなく整理されたコンテキストを必要とする場合は、これらのリンクを使ってください。
テストする
「documentation-writer」を使用しています。 新しい開発者向け機能のオンボーディングドキュメント作成依頼。
期待される結果:
対象読者と目標に関する確認質問に続き、最初の成功結果に焦点を当てたチュートリアルのアウトライン。
「documentation-writer」を使用しています。 デプロイタスク向けに承認済みのアウトライン。
期待される結果:
前提条件、順序立てた手順、期待される結果、簡潔なトラブルシューティングメモを含む Markdown のハウツーガイド。
「documentation-writer」を使用しています。 製品のトーンと用語を定義する既存の Markdown ファイル。
期待される結果:
ソーステキストをコピーせず、同じ語り口、命名、構造に従った改訂版ドキュメントドラフト。
セキュリティ監査
安全The skill contains prompt guidance for technical writing and no executable network operation. The Diátaxis website URL is a framework citation, not a request target or data transfer mechanism.
リスク要因
🌐 ネットワークアクセス (1)
このレポートを共有・引用
バージョン付き評価レポート、中立的なバッジ、埋め込みカード、引用を共有できます。Skillstore は証拠を報告しますが、この Skill が安全かどうかは判断しません。
レポートリンクをコピー
https://skillstore.io/skills/github-documentation-writer/audits/5?utm_source=security_passport&utm_medium=share&utm_campaign=versioned_reportMarkdownバッジ
[](https://skillstore.io/skills/github-documentation-writer?utm_source=security_passport_badge)HTMLバッジ
<a href="https://skillstore.io/skills/github-documentation-writer?utm_source=security_passport_badge"><img src="https://skillstore.io/badges/skills/github-documentation-writer/security.svg" alt="Skillstore security assessment" loading="lazy"></a>埋め込みカード
<iframe src="https://skillstore.io/embed/skills/github-documentation-writer.html" title="Skillstore Security Assessment" sandbox="allow-popups allow-popups-to-escape-sandbox" loading="lazy" referrerpolicy="no-referrer" width="420" height="180"></iframe>学術引用 (APA · BibTeX · CFF)
APA形式の引用
github. (2026). documentation-writer security audit report (audit version 5) [Author version unspecified]. Skillstore. https://skillstore.io/skills/github-documentation-writer/audits/5BibTeX形式の引用
@techreport{github-github-documentation-writer-2026,
author = {github},
title = {documentation-writer security audit report (audit version 5)},
institution = {Skillstore},
year = {2026},
number = {5},
url = {https://skillstore.io/skills/github-documentation-writer/audits/5},
note = {Author version unspecified}
}CITATION.cff
cff-version: 1.2.0
message: "If you use this Skill, cite its author and this versioned security audit report."
title: "documentation-writer security audit report (audit version 5)"
version: "unspecified"
type: report
authors:
- name: "github"
date-released: "2026-07-23"
url: "https://skillstore.io/skills/github-documentation-writer/audits/5"
identifiers:
- type: other
value: "skillstore:github-documentation-writer:audit:5"
description: "Skillstore immutable audit report identifier"
バリアントを比較
インストール可能なバリアント 2 件各作者のスキルは個別のインストール項目として維持されます。推奨バリアントは Skillstore の証拠で順位付けされます。
このバリアントが首位の理由
github-documentation-writer
2026-09-09
c0ntr0lledcha0s-documentation-writer
2026-09-09
Skillstore スコア
このスコアの理由 証拠の信頼度: 高作成できるもの
製品チュートリアルを計画する
ガイド付きで最初の成功体験を必要とするユーザー向けに、学習重視のアウトラインとドラフトを作成します。
運用ハウツーガイドを書く
特定のタスクを、スコープと前提条件を含む明確な手順に変換します。
リファレンスページを下書きする
技術的事実を、繰り返し参照し保守しやすい簡潔なリファレンス資料として整理します。
これらのプロンプトを試す
[product or feature] のドキュメントが必要です。チュートリアル、ハウツーガイド、リファレンスページ、解説のどれにすべきか選ぶのを手伝ってください。まず必要な確認質問をしてください。
[topic] についての [document type] 向けに、Diataxis に基づくアウトラインを作成してください。対象読者は [audience]、目標は [goal]、スコープは [scope] です。
承認済みのアウトラインを使用して、完全な Markdown ドキュメントを書いてください。言語はシンプルで正確にし、提供された製品詳細と一貫させてください。
これらのドキュメントドラフトを Diataxis の観点でレビューしてください。改訂案を提案する前に、目的の混在、不足している対象読者の文脈、スコープの問題、用語の不整合を特定してください。
ベストプラクティス
- 最初に対象読者、ユーザーの目標、スコープ、ドキュメント種別を提供します。
- 最終ドラフトを依頼する前に、提案されたアウトラインをレビューして承認します。
- トーン、用語、構造を合わせる必要がある場合は、既存のドキュメントを共有します。
回避
- 製品詳細や明確なユーザー目標なしに完全なドキュメントを依頼すること。
- 1つのページにチュートリアル、リファレンス、解説の目標を混在させること。
- 信頼できるリンクや指示を提供せずに外部調査を求めること。