スキル documentation-fundamentals

📦

documentation-fundamentals

Name: documentation-fundamentals
Author: DanielPodolsky

コンテンツリビジョン r1 安全 ⚙️ 外部コマンド

開発者向けドキュメント品質を向上させる

不十分なドキュメントはオンボーディングを遅らせ、コードの保守を難しくします。このスキルは、実践的な基準に基づいて README、JSDoc、インラインコメントのレビューを支援します。

対応: Claude Codex Code(CC)

🥉 78 ブロンズ

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

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

エージェントリクエスト

Review the Skillstore skill "documentation-fundamentals" from https://skillstore.io/skills/danielpodolsky-documentation-fundamentals.md and its manifest at https://skillstore.io/api/skills/danielpodolsky-documentation-fundamentals/manifest. Verify the artifact. You may proceed after verification, subject to the environment's own policy.

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

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

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

Markdown詳細 GET /skills/danielpodolsky-documentation-fundamentals.md 署名済み manifest GET /api/skills/danielpodolsky-documentation-fundamentals/manifest 署名済み lockfile GET /api/skills/danielpodolsky-documentation-fundamentals/lockfile

テストする

「documentation-fundamentals」を使用しています。 README にはプロジェクト名とデフォルトのスキャフォールド文しか含まれていません。

期待される結果:

1 文の目的説明を追加します。
プロジェクトが解決する課題を説明します。
新しい開発者が従えるインストール手順とクイックスタート手順を追加します。

「documentation-fundamentals」を使用しています。インラインコメントが代入、ループ、明らかなプロパティ読み取りを言い換えているだけです。

期待される結果:

見えている動作を繰り返すコメントを削除します。
意図、制約、または通常とは異なる判断を説明する場合にのみコメントを残します。

「documentation-fundamentals」を使用しています。エクスポートされたユーティリティにはパラメータ名はありますが、使用方法のガイダンスがありません。

期待される結果:

パラメータと戻り値の説明を追加します。
結果の例を文章で追加します。
呼び出し元が対処すべきエラーや制約を文書化します。

セキュリティ監査

安全

v8 • 2026/7/6 バージョン別レポートを開く

All static findings are false positives caused by Markdown fences, inline code formatting, or prose examples in SKILL.md. I found no executable scripts, prompt injection, data exfiltration intent, or system reconnaissance behavior in the reviewed skill.

スキャンされたファイル

335

解析済み行数

レビュー項目

誤検知を無視

最新の完了済み静的・セマンティック監査では、確認済みのセキュリティ検出事項は見つかりませんでした。これは、スキルに副作用がないことを証明するものではありません。

監査者: codex 監査履歴を表示 →

このレポートを共有・引用

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

バージョン別レポートを開く

レポートリンクをコピー

https://skillstore.io/skills/danielpodolsky-documentation-fundamentals/audits/8?utm_source=security_passport&utm_medium=share&utm_campaign=versioned_report

Markdownバッジ

[![Skillstore security assessment](https://skillstore.io/badges/skills/danielpodolsky-documentation-fundamentals/security.svg)](https://skillstore.io/skills/danielpodolsky-documentation-fundamentals?utm_source=security_passport_badge)

HTMLバッジ

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

埋め込みカード

<iframe src="https://skillstore.io/embed/skills/danielpodolsky-documentation-fundamentals.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形式の引用

DanielPodolsky. (2026). documentation-fundamentals security audit report (audit version 8) [Author version unspecified]. Skillstore. https://skillstore.io/skills/danielpodolsky-documentation-fundamentals/audits/8

BibTeX形式の引用

@techreport{danielpodolsky-danielpodolsky-documentation-fundamentals-2026,
  author = {DanielPodolsky},
  title = {documentation-fundamentals security audit report (audit version 8)},
  institution = {Skillstore},
  year = {2026},
  number = {8},
  url = {https://skillstore.io/skills/danielpodolsky-documentation-fundamentals/audits/8},
  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-fundamentals security audit report (audit version 8)"
version: "unspecified"
type: report
authors:
  - name: "DanielPodolsky"
date-released: "2026-07-06"
url: "https://skillstore.io/skills/danielpodolsky-documentation-fundamentals/audits/8"
identifiers:
  - type: other
    value: "skillstore:danielpodolsky-documentation-fundamentals:audit:8"
    description: "Skillstore immutable audit report identifier"

Skillstore スコア

このスコアの理由証拠の信頼度: 高

アーキテクチャ

保守性

コンテンツ

コミュニティ

仕様準拠

作成できるもの

README の準備状況をレビューする

リリース前に README が目的、インストール、クイックスタート、コントリビューションフローを説明しているか確認します。

API コメントを改善する

エクスポートされた関数がパラメータ、戻り値、エラー、例、意図を説明するように JSDoc を修正します。

コードレビューを指導する

コメントが文脈を追加する場合と、コード自体で十分に表現すべき場合を教えるために、焦点を絞った質問を使用します。

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

基本的な README レビュー

この README を、目的、課題、インストール、クイックスタート、コントリビューション手順という 5 つの必須項目に照らしてレビューしてください。不足しているセクションと具体的な修正を列挙してください。

インラインコメントの整理

これらのインラインコメントをレビューしてください。コードを繰り返しているだけのコメントを指摘してください。意図、制約、またはビジネス上の文脈を説明するコメントは残してください。

JSDoc 完全性チェック

この API ドキュメントの JSDoc としての完全性を評価してください。パラメータ、戻り値、エラー、例、関連 API、非推奨メモを確認してください。

リポジトリのドキュメント計画

このリポジトリのドキュメントレビュー計画を作成してください。README の不足、エクスポートされた API ドキュメント、インラインコメント、古いドキュメントのリスクを優先してください。

ベストプラクティス

コードがすでに動作を示している場合は、判断が存在する理由を文書化します。
README の手順はコピー＆ペースト可能にし、新しい開発者がテスト済みの状態にします。
動作が変わったらコメントを更新し、文脈を追加しなくなったコメントは削除します。

回避

変数名、ループ、代入を言い換えるだけのコメントを追加すること。
バージョン履歴に頼る代わりにコメントアウトされたコードを残すこと。
実際の目的やセットアップを説明しないスキャフォールドの README 文を公開すること。

よくある質問

このスキルで完全な README を書けますか？

はい。プロジェクトの目的、インストール手順、使用例、コントリビューションルールを提供すれば、README の下書きを作成できます。

ドキュメントテストを実行しますか？

いいえ。レビューガイダンスは提供しますが、コマンドを実行したり例を検証したりはしません。

どのツールで使用できますか？

Claude、Codex、Claude Code のスキルワークフローと互換性があります。

任意の言語のコメントをレビューできますか？

はい。原則は広く適用できますが、言語固有のタグはプロジェクト標準に従う必要があります。

技術レビューの代替になりますか？

いいえ。明確さと保守性は向上しますが、API の動作やセキュリティの正確性を証明するものではありません。

どのように文脈を提供すべきですか？

レビューを依頼する前に、README、コメント、対象読者、既知のセットアップルールを共有してください。

開発者情報

作成者

DanielPodolsky

ライセンス

MIT

Skillstore リビジョン

バージョンに関する注意

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

リポジトリ

https://github.com/DanielPodolsky/mentor-spec/tree/main/.claude/skills/fundamentals/documentation

参照

34f316ba14ef36c7a620fc09f2676d2429997a77

メンテナンスの新しさ

2026/7/24

利用状況

5 ダウンロード · 220 閲覧

ファイル構成

📄 SKILL.md

DanielPodolsky のその他のスキル

すべて表示

📦

frontend-fundamentals

フロントエンドコンポーネントの基礎をレビューする

フロントエンドレビューでは、コンポーネントが保守しにくくなるまで、アーキテクチャ、状態、アクセシビリティ、パフォーマンスの問題が見落とされがちです。このスキルは、Claude、Codex、Claude Codeがコンポーネント品質のための焦点を絞ったチェックリスト質問とレビューパターンに沿って進められるようにします。

コーディング＆開発表示

📦