documentation
完全なプロジェクトドキュメントを作成
チームはAPI、アーキテクチャ、オンボーディング、リリース全体で重要なドキュメントを見落としがちです。このワークフローは、ドキュメント作成タスクを明確なフェーズと焦点を絞ったプロンプトに整理します。
自分のエージェントでインストール
このリクエストをエージェントにコピーしてください。正規の Skill ページとマニフェストが含まれています。
Review the Skillstore skill "documentation" from https://skillstore.io/skills/sickn33-documentation.md and its manifest at https://skillstore.io/api/skills/sickn33-documentation/manifest. Verify the artifact. You may proceed after verification, subject to the environment's own policy.エージェントは引き続き計画を提示し、セキュリティポリシーで必要な確認を求める必要があります。
エージェントが読めるリソース
AI エージェント、クローラー、スクリプトがページ全体ではなく整理されたコンテキストを必要とする場合は、これらのリンクを使ってください。
テストする
「documentation」を使用しています。 チームが新しいサービスのドキュメントを必要としています。
期待される結果:
READMEコンテンツ、APIリファレンス、アーキテクチャ図、セットアップ手順、オーナーレビューをカバーする段階的なドキュメント計画。
「documentation」を使用しています。 プロジェクトにはエンドポイントがありますが、APIリファレンスがありません。
期待される結果:
エンドポイントグループ、認証ガイダンス、リクエストフィールド、レスポンス説明、例の網羅範囲を含むAPIドキュメントのアウトライン。
「documentation」を使用しています。 リリースにユーザー向けノートと内部向け更新が必要です。
期待される結果:
changelog項目、リリースノート、更新されたwikiページ、リンク検証タスクを含むリリースドキュメントチェックリスト。
セキュリティ監査
安全All 63 static findings were reviewed against SKILL.md. The 61 execution alerts are Markdown syntax, while both reconnaissance alerts are ordinary documentation text without executable behavior or malicious intent.
リスク要因
⚙️ 外部コマンド (50)
このレポートを共有・引用
バージョン付き評価レポート、中立的なバッジ、埋め込みカード、引用を共有できます。Skillstore は証拠を報告しますが、この Skill が安全かどうかは判断しません。
レポートリンクをコピー
https://skillstore.io/skills/sickn33-documentation/audits/5?utm_source=security_passport&utm_medium=share&utm_campaign=versioned_reportMarkdownバッジ
[](https://skillstore.io/skills/sickn33-documentation?utm_source=security_passport_badge)HTMLバッジ
<a href="https://skillstore.io/skills/sickn33-documentation?utm_source=security_passport_badge"><img src="https://skillstore.io/badges/skills/sickn33-documentation/security.svg" alt="Skillstore security assessment" loading="lazy"></a>埋め込みカード
<iframe src="https://skillstore.io/embed/skills/sickn33-documentation.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形式の引用
sickn33. (2026). documentation security audit report (audit version 5) [Author version unspecified]. Skillstore. https://skillstore.io/skills/sickn33-documentation/audits/5BibTeX形式の引用
@techreport{sickn33-sickn33-documentation-2026,
author = {sickn33},
title = {documentation security audit report (audit version 5)},
institution = {Skillstore},
year = {2026},
number = {5},
url = {https://skillstore.io/skills/sickn33-documentation/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 security audit report (audit version 5)"
version: "unspecified"
type: report
authors:
- name: "sickn33"
date-released: "2026-07-23"
url: "https://skillstore.io/skills/sickn33-documentation/audits/5"
identifiers:
- type: other
value: "skillstore:sickn33-documentation:audit:5"
description: "Skillstore immutable audit report identifier"
バリアントを比較
インストール可能なバリアント 5 件各作者のスキルは個別のインストール項目として維持されます。推奨バリアントは Skillstore の証拠で順位付けされます。
このバリアントが首位の理由
89jobrien-documentation
2026-09-09
daothihuong2111-documentation
2026-09-09
Skillstore スコア
このスコアの理由 証拠の信頼度: 高作成できるもの
ドキュメントセットを計画する
API、アーキテクチャ、ユーザーガイド、メンテナンスタスクのための構造化された計画を作成します。
ソフトウェアプロジェクトを文書化する
コードベースをREADMEファイル、コードコメント、APIリファレンス、図に変換します。
リリースドキュメントを保守する
changelog、リリースノート、オンボーディングページ、ドキュメント品質チェックを準備します。
これらのプロンプトを試す
このプロジェクトのREADMEアウトラインを作成し、セットアップ、使用方法、例、トラブルシューティングのセクションを含めてください。
これらのエンドポイントをレビューし、認証メモ、リクエスト詳細、レスポンス、使用例を含むAPIドキュメントを作成してください。
C4ビュー、データフロー、デプロイメントメモ、図の要件を含むアーキテクチャドキュメント計画を作成してください。
計画、作成、レビュー、公開、保守、品質ゲートのための完全なドキュメント作成ワークフローを設計してください。
ベストプラクティス
- ドキュメントの範囲、対象読者、受け入れ基準から始めます。
- ドキュメントセットを作成する際は、ワークフローのフェーズを順番に使用します。
- 公開前に、生成されたコンテンツを品質ゲートに照らしてレビューします。
回避
- コマンド、リンク、図、例の検証を省略する。
- 必要な成果物が1つだけの場合に、すべてのドキュメントタイプを要求する。
- 技術オーナーのレビューなしに生成されたドキュメントを公開する。