スキル documentation-generation-doc-generate
📦

documentation-generation-doc-generate

コンテンツリビジョン r2 安全 ⚙️ 外部コマンド🌐 ネットワークアクセス📁 ファイルシステムへのアクセス🔑 環境変数

產生可維護的程式碼文件

手動文件通常會落後於活躍開發中的程式碼。這項技能可協助 Claude、Codex 和 Claude Code 建立清晰的文件與自動化計畫。

対応: Claude Codex Code(CC)
Maintain this Skill? Claim it 🥉 79 ブロンズ

自分のエージェントでインストール

このリクエストをエージェントにコピーしてください。正規の Skill ページとマニフェストが含まれています。

エージェントリクエスト
Review the Skillstore skill "documentation-generation-doc-generate" from https://skillstore.io/skills/sickn33-documentation-generation-doc-generate.md and its manifest at https://skillstore.io/api/skills/sickn33-documentation-generation-doc-generate/manifest. Verify the artifact. You may proceed after verification, subject to the environment's own policy.

エージェントは引き続き計画を提示し、セキュリティポリシーで必要な確認を求める必要があります。

エージェントが読めるリソース

AI エージェント、クローラー、スクリプトがページ全体ではなく整理されたコンテキストを必要とする場合は、これらのリンクを使ってください。

テストする

「documentation-generation-doc-generate」を使用しています。 後端服務需要在 API 上線前完成文件。

期待される結果:

  • API 參考大綱,包含端點群組、驗證說明與錯誤章節。
  • 關於版本控管、速率限制與範例回應的待釐清問題。
  • 發布前建議的驗證步驟。

「documentation-generation-doc-generate」を使用しています。 團隊想為微服務系統建立架構文件。

期待される結果:

  • 系統概覽,包含服務職責與資料流。
  • 以 Mermaid notation 作為目標格式的圖表計畫。
  • 需要 owner 審查的風險與假設。

「documentation-generation-doc-generate」を使用しています。 repository 有零散的設定說明,且沒有貢獻者指南。

期待される結果:

  • README 結構,包含設定、組態、測試與貢獻章節。
  • 需要與維護者確認的缺漏資訊清單。
  • 讓文件保持最新的自動化檢查清單。

セキュリティ監査

安全

All 30 static findings are false positives caused by prose, Markdown formatting, placeholders, and illustrative code or workflow examples. The skill contains no executable scripts and does not directly access commands, networks, files, or environment secrets. No prompt injection or malicious intent was found.

2
スキャンされたファイル
698
解析済み行数
0
レビュー項目
0
誤検知を無視
最新の完了済み静的・セマンティック監査では、確認済みのセキュリティ検出事項は見つかりませんでした。これは、スキルに副作用がないことを証明するものではありません。
監査者: codex 監査履歴を表示 →
このレポートを共有・引用

バージョン付き評価レポート、中立的なバッジ、埋め込みカード、引用を共有できます。Skillstore は証拠を報告しますが、この Skill が安全かどうかは判断しません。

バージョン別レポートを開く
セキュリティ評価

レポートリンクをコピー

https://skillstore.io/skills/sickn33-documentation-generation-doc-generate/audits/5?utm_source=security_passport&utm_medium=share&utm_campaign=versioned_report

Markdownバッジ

[![Skillstore security assessment](https://skillstore.io/badges/skills/sickn33-documentation-generation-doc-generate/security.svg)](https://skillstore.io/skills/sickn33-documentation-generation-doc-generate?utm_source=security_passport_badge)

HTMLバッジ

<a href="https://skillstore.io/skills/sickn33-documentation-generation-doc-generate?utm_source=security_passport_badge"><img src="https://skillstore.io/badges/skills/sickn33-documentation-generation-doc-generate/security.svg" alt="Skillstore security assessment" loading="lazy"></a>

埋め込みカード

<iframe src="https://skillstore.io/embed/skills/sickn33-documentation-generation-doc-generate.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-generation-doc-generate security audit report (audit version 5) [Author version unspecified]. Skillstore. https://skillstore.io/skills/sickn33-documentation-generation-doc-generate/audits/5

BibTeX形式の引用

@techreport{sickn33-sickn33-documentation-generation-doc-generate-2026, author = {sickn33}, title = {documentation-generation-doc-generate security audit report (audit version 5)}, institution = {Skillstore}, year = {2026}, number = {5}, url = {https://skillstore.io/skills/sickn33-documentation-generation-doc-generate/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-generation-doc-generate 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-generation-doc-generate/audits/5" identifiers: - type: other value: "skillstore:sickn33-documentation-generation-doc-generate:audit:5" description: "Skillstore immutable audit report identifier"

Skillstore スコア

このスコアの理由 証拠の信頼度: 高
55
アーキテクチャ
85
保守性
87
コンテンツ
69
コミュニティ
91
仕様準拠

作成できるもの

記錄 API 發行版本

根據現有路由定義建立端點參考、驗證說明、回應描述與互動式 API 文件。

說明系統架構

將服務、資料儲存與部署細節轉換為圖表與精簡的元件文件。

標準化專案文件

以一致結構建立 README、設定、使用者指南、貢獻與疑難排解章節。

これらのプロンプトを試す

建立文件計畫
檢閱此 repository 並提出文件計畫。包含受眾、必要文件、要檢查的來源檔案,以及待釐清問題。
產生 API 參考草稿
分析路由定義並起草 API 文件。包含端點、參數、驗證、錯誤、範例與驗證缺口。
建立架構文件
為此應用程式建立架構文件。包含元件、資料流、相依性、圖表、營運考量與假設。
設計文件自動化
設計文件自動化工作流程。包含產生步驟、linting、涵蓋率檢查、審查關卡、部署與維護風險。

ベストプラクティス

  • 發布前,請依照原始碼檢閱產生的文件。
  • 將所有 placeholder 替換為專案專屬值。
  • 遮蔽 secrets、內部 URLs 與敏感實作細節。

回避

  • 未經維護者審查就發布產生的文件。
  • 將 placeholder 命令或 tokens 複製到正式文件中。
  • 在公開 repositories 中記錄私有基礎設施細節。

よくある質問

這項技能可以產生哪些類型的文件?
它支援 API 文件、架構說明、README 內容、使用者指南、開發者指南與文件自動化計畫。
它會自動修改我的程式碼嗎?
不會。它專注於文件規劃、草稿、範本與審查檢查清單。
它可以建立 OpenAPI 文件嗎?
可以。playbook 包含 OpenAPI 結構範例與互動式 API 文件模式。
它可以建立圖表嗎?
可以。它包含以 Mermaid 為基礎的架構與元件圖範例。
我應該立即發布產生的文件嗎?
不應該。發布前請檢查準確性、安全性、placeholder、連結與是否符合受眾需求。
它可以與 Claude、Codex 和 Claude Code 搭配使用嗎?
可以。報告列出 Claude、Codex 和 Claude Code 為支援的工具。

開発者情報

作成者

sickn33

ライセンス

MIT

Skillstore リビジョン

r2

バージョンに関する注意

作者はバージョンを宣言していません。

参照

f9e2c34b4f19c7f3e6b0a1e93227b5f77cc12526

メンテナンスの新しさ

2026/7/26

利用状況

10 ダウンロード · 108 閲覧

ファイル構成

sickn33 のその他のスキル

すべて表示
すべて表示