post-impl-docs
実装後ドキュメントの更新
コード変更によって、README ファイル、変更履歴、docstring が古くなることはよくあります。このスキルは完了した実装作業をレビューし、ユーザーが正確なガイダンスを必要とする箇所のドキュメントを更新します。
自分のエージェントでインストール
このリクエストをエージェントにコピーしてください。正規の Skill ページとマニフェストが含まれています。
Review the Skillstore skill "post-impl-docs" from https://skillstore.io/skills/consiliency-post-impl-docs.md and its manifest at https://skillstore.io/api/skills/consiliency-post-impl-docs/manifest. Verify the artifact. You may proceed after verification, subject to the environment's own policy.エージェントは引き続き計画を提示し、セキュリティポリシーで必要な確認を求める必要があります。
エージェントが読めるリソース
AI エージェント、クローラー、スクリプトがページ全体ではなく整理されたコンテキストを必要とする場合は、これらのリンクを使ってください。
テストする
「post-impl-docs」を使用しています。 実装 diff に例付きで新しい公開認証エンドポイントが追加されました。
期待される結果:
- README に簡潔な機能エントリと更新された使用ガイダンスが追加されます。
- CHANGELOG の適切なセクションに、ユーザー向けの機能エントリが追加されます。
- 関連する docs ページと docstring について、古くなった認証詳細がないか確認されます。
「post-impl-docs」を使用しています。 関数が新しい設定オプションを必須とし、新しい検証エラーを発生させるようになりました。
期待される結果:
- API ドキュメントに新しいオプションとデフォルト動作が記載されます。
- docstring に新しいパラメーターと検証エラーが含められます。
- ユーザーが現在の呼び出しパターンを確認できるように、例が更新されます。
「post-impl-docs」を使用しています。 リファクタリングにより内部構造が変更されましたが、ユーザー向けの動作変更はありません。
期待される結果:
このスキルは、公開ドキュメントの変更は不要であることを報告しつつ、整合がまだ必要な docstring があれば指摘します。
セキュリティ監査
安全All 79 static findings are false positives caused by Markdown syntax, public documentation links, a placeholder credential, and exception text. The documented commands support repository inspection and documentation checks, with no hidden execution, credential access, exfiltration, or prompt injection. Users should still review generated documentation changes before committing them.
リスク要因
⚙️ 外部コマンド (50)
🌐 ネットワークアクセス (5)
🔑 環境変数 (1)
このレポートを共有・引用
バージョン付き評価レポート、中立的なバッジ、埋め込みカード、引用を共有できます。Skillstore は証拠を報告しますが、この Skill が安全かどうかは判断しません。
レポートリンクをコピー
https://skillstore.io/skills/consiliency-post-impl-docs/audits/10?utm_source=security_passport&utm_medium=share&utm_campaign=versioned_reportMarkdownバッジ
[](https://skillstore.io/skills/consiliency-post-impl-docs?utm_source=security_passport_badge)HTMLバッジ
<a href="https://skillstore.io/skills/consiliency-post-impl-docs?utm_source=security_passport_badge"><img src="https://skillstore.io/badges/skills/consiliency-post-impl-docs/security.svg" alt="Skillstore security assessment" loading="lazy"></a>埋め込みカード
<iframe src="https://skillstore.io/embed/skills/consiliency-post-impl-docs.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形式の引用
Consiliency. (2026). post-impl-docs security audit report (audit version 10) [Author version unspecified]. Skillstore. https://skillstore.io/skills/consiliency-post-impl-docs/audits/10BibTeX形式の引用
@techreport{consiliency-consiliency-post-impl-docs-2026,
author = {Consiliency},
title = {post-impl-docs security audit report (audit version 10)},
institution = {Skillstore},
year = {2026},
number = {10},
url = {https://skillstore.io/skills/consiliency-post-impl-docs/audits/10},
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: "post-impl-docs security audit report (audit version 10)"
version: "unspecified"
type: report
authors:
- name: "Consiliency"
date-released: "2026-07-13"
url: "https://skillstore.io/skills/consiliency-post-impl-docs/audits/10"
identifiers:
- type: other
value: "skillstore:consiliency-post-impl-docs:audit:10"
description: "Skillstore immutable audit report identifier"
Skillstore スコア
このスコアの理由 証拠の信頼度: 高作成できるもの
新機能を文書化する
公開機能を追加した後に、README、変更履歴、使用例を更新します。
リリースノートを準備する
リリース前に、完了した実装作業を明確な変更履歴エントリに変換します。
API リファレンスを保守する
公開関数のシグネチャや動作が変更された後に、ドキュメントと docstring を更新します。
これらのプロンプトを試す
最新の実装 diff をレビューし、ユーザー向けの動作が変更された箇所だけ README と CHANGELOG を更新してください。
最後のコミットでの公開 API 変更を見つけ、README の使用例を更新し、影響を受ける docs フォルダー内の参照を調整してください。
変更された関数とクラスをレビューし、変更されたパラメーター、戻り値、例外、例に合わせて docstring を更新してください。
すべての実装変更を分類し、リリースノート、README、docs、docstring を更新したうえで、何がなぜ変更されたのかを要約してください。
ベストプラクティス
- ドキュメントを編集する前に、実装 diff をレビューします。
- 非公開の実装詳細ではなく、ユーザーから見える動作を文書化します。
- 既存の README、変更履歴、docstring のスタイルに合わせます。
回避
- フォーマットのみの変更に対して変更履歴エントリを追加すること。
- 新しい API 形状を確認せずに例を更新すること。
- 内部リファクタリングを公開プロダクト変更として文書化すること。
よくある質問
このスキルはいつ実行すべきですか?
すべてのドキュメントファイルを更新しますか?
変更履歴エントリを書けますか?
リリースノートを自動的に作成しますか?
インライン docstring を更新できますか?
例のテストを実行しますか?
開発者情報
作成者
Consiliencyライセンス
MIT
Skillstore リビジョン
r1
バージョンに関する注意
作者はバージョンを宣言していません。
参照
635f69fb8d2f4e6330ba47a4e5a0fb239c04d110
メンテナンスの新しさ
2026/7/22
利用状況
5 ダウンロード · 201 閲覧
ファイル構成