documentation-reviewer SKILL.md skillA

documentation-reviewer from ncaq/konoka is an agent skill: a SKILL.md folder an AI agent loads when a task calls for it.

Install it, pinned
mdr add ncaq/konoka/documentation-reviewer@git:20260801.edf4d79

Pins git:20260801.edf4d79 in mdr.lock. Pin the fingerprint instead.

Audit grade
A, 17 of 17 checks passed
Kind
SKILL.md skill
Repository
ncaq/konoka
Path
plugins/kyosei/skills/documentation-reviewer/SKILL.md
Versions recorded
4
Latest version
git:20260801.edf4d79, committed Aug 1, 2026
First version recorded
Jul 23, 2026
Size
4,630 bytes
Repository stars
3
License
Apache-2.0

Use when you need to verify that code documentation is accurate, complete, and up-to-date. Use this skill after: - Implementing new features that require documentation updates - Modifying existing APIs or functions - Completing a logical chunk of code that needs documentation review - Preparing code for review/release.

Collected from public GitHub. Every version is saved exactly as it was and never changes. Install it at an exact version with the mdr tool, and every file is checked before it reaches your agent. The main file is checked against the SHA-256 fingerprint recorded here, and the others against the fingerprints GitHub keeps for its source commit. The automatic checks below grade the latest version, and the same checks always give the same file the same grade.

What the file says

あなたはコードドキュメント標準、
APIドキュメントのベストプラクティス、
テクニカルライティングに深い専門知識を持つ、
テクニカルドキュメントレビューの専門家です。

# レビュー対象

以下はkyoseiスキル本体がget-review-infoで取得した、
レビュー対象ファイルへの絶対パスを持つJSONです。
JSONに含まれるファイルを`Read`ツールで直接読んでレビューしてください。
特に`patch`はレビュー対象の差分です。

$ARGUMENTS

# レビューするときの注意

ドキュメントをレビューする際は、
以下の観点で評価してください:

## コードドキュメント分析

- 全てのパブリックな関数、メソッド、型に適切なドキュメントコメントがあるか確認する
- パラメータの説明が実際のパラメータの型と目的に一致しているか確認する
- 戻り値のドキュメントがコードの実際の返り値を正確に記述しているか確認する
- ドキュメント内の例が現在の実装で実際に動作するか検証する
- エッジケースとエラー条件が適切にドキュメント化されているか確認する
- 削除または変更された機能を参照する古くなったコメントを検出する

## README検証

- READMEの内容と実際に実装されている機能を照合する
- インストール手順が最新かつ完全であるか確認する
- 使用例が現在のAPIを反映しているか確認する
- 機能一覧が利用可能な機能を正確に表しているか確認する
- READMEに記載された設定オプションが実際のコードと一致しているか検証する
- READMEドキュメントに記載されていない新機能を特定する

## APIドキュメントレビュー

- エンドポイントの説明が実際の実装と一致しているか確認する
- リクエスト/レスポンスの例の正確性を確認する
- 認証要件が正しくドキュメント化されているか確認する
- パラメータの型、制約、デフォルト値を検証する
- エラーレスポンスのドキュメントが実際のエラーハンドリングと一致しているか確認する
- 非推奨のエンドポイントが適切にマークされているか確認する

## 品質基準

- 曖昧、不明確、または誤解を招くドキュメントを指摘する
- パブリックインターフェースのドキュメント欠落を特定する
- ドキュメントと実装の間の不一致を指摘する
- 明確さと完全性の改善を提案する
- CLAUDE.mdのプロジェクト固有の基準に従っているか確認する

# レポート形式

発見事項をJSON配列で報告してください。

JSON以外のテキストは出力しないでください。

Markdownのコードブロック記法も付けないでください。

以下のような形式で出力してください。

```json
[
  {
…

Read the whole file at its exact version.

How to install

The exact contents, by fingerprint
mdr add ncaq/konoka/documentation-reviewer@sha256:7814691051aa09ec

The line at the top of this page pins the label git:20260801.edf4d79, which is what most people want. This one pins the sha256 fingerprint of the contents instead, so it survives a label being moved. Either way the exact version is written to mdr.lock, and mdr install downloads and checks those contents again, so it installs them exactly or stops with an error.

Badge

mdr badge

[![mdr](https://markdownregistry.com/badge/art_mblyi2wb6lea6x5v.svg)](https://markdownregistry.com/a/art_mblyi2wb6lea6x5v)

2 badge image fetches in 30 days. What the badge shows.

Versions

The registry has recorded 4 versions of this file, between Jul 23, 2026 and Aug 1, 2026, about one every 3 days.

versioncommittedcommitsizeaudit
git:20260801.edf4d79 latest2026-08-01 edf4d79 4,630 BA view · diff
git:20260801.b8aebce2026-08-01 b8aebce 4,613 BA view · diff
git:20260728.44842e42026-07-28 44842e4 4,421 BA view · diff
git:20260723.1bc38fc2026-07-23 1bc38fc 4,419 BA view

Audit of the latest version

A  17 of 17 checks passed. Fixed automatic checks with no AI involved, so the same checks give the same answer every run.
  • pass: Frontmatter block present
  • pass: Frontmatter declares a name
  • pass: Frontmatter declares a description
  • pass: Size between 200 bytes and 200 KB (4630 bytes)
  • pass: No zero-width or bidi control characters
  • pass: No instruction hidden inside an HTML comment
  • pass: No link to an exfiltration or paste host
  • pass: No credential-shaped string
  • pass: No instruction to send local credentials anywhere
  • pass: No text hidden with inline styles
  • pass: No prompt-injection phrasing
  • pass: No curl or wget piped into a shell
  • pass: No recursive delete of root, home or parent
  • pass: No instruction to read or print local credentials
  • pass: No base64 blob over 200 characters
  • pass: No link to a raw IP address
  • pass: No script tag

Source

GitHub

ncaq/konoka · 3 stars · license Apache-2.0 · pushed 2026-10-19 · branch master

API

GET https://markdownregistry.com/api/v1/artifacts/art_mblyi2wb6lea6x5v
GET https://markdownregistry.com/api/v1/resolve?ref=ncaq/konoka/documentation-reviewer
GET https://markdownregistry.com/api/v1/blob/7814691051aa09ec84433fc974aa9d548e63064005a74e8e340bab657ed4f16c

Your AI assistant does the legwork. You hear about the deals worth your word. Hand yours the standing instructions at modelranch.com and it joins the network that reads files like this one.

Guides: the SKILL.md format and its required fields · what to check before you install a skill · how to pin a skill to an exact version · where to find agent skills · keeping a team on the same skills · which agent file does what.

More from ncaq/konoka

AGENTS.md AGENTS.md file
ncaq/konoka · AGENTS.md
git:20260329.5b4489e · audit B · 3 stars
CLAUDE.md CLAUDE.md file
ncaq/konoka · CLAUDE.md
git:20260329.5b4489e · audit B · 3 stars
commit-style SKILL.md skill
ncaq/konoka · plugins/commit/skills/commit-style/SKILL.md · Commit message style guidelines. Use when writing or proposing git commit messages, including direct git commit…
git:20260815.bd27938 · audit A · 3 stars
commit SKILL.md skill
ncaq/konoka · plugins/commit/skills/commit/SKILL.md · Generate a commit message from staged changes, then let the user review before committing in manual mode or commit…
git:20260822.e17c526 · audit A · 3 stars
bracket SKILL.md skill
ncaq/konoka · plugins/haskell-tasuke/skills/bracket/SKILL.md · Use bracket or with-style functions to guarantee resource cleanup even on exceptions instead of separate do blocks. Use…
git:20260521.babbbee · audit A · 3 stars
bump-cabal-index-state SKILL.md skill
ncaq/konoka · plugins/haskell-tasuke/skills/bump-cabal-index-state/SKILL.md · Update Cabal project index-state to the latest timestamp. Use when it needs to bump the cabal index-state.
git:20260531.5461ac6 · audit A · 3 stars
cabal-command SKILL.md skill
ncaq/konoka · plugins/haskell-tasuke/skills/cabal-command/SKILL.md · Use cabal with --disable-optimization for development builds and tests, and add --enable-tests to avoid rebuilds. Use…
git:20260521.904d064 · audit A · 3 stars
exception SKILL.md skill
ncaq/konoka · plugins/haskell-tasuke/skills/exception/SKILL.md · Do not throw exceptions from pure code with error or throw, give exceptions structured types, and never silently…
git:20260521.6406d80 · audit A · 3 stars
export SKILL.md skill
ncaq/konoka · plugins/haskell-tasuke/skills/export/SKILL.md · Explicitly enumerate Haskell module exports instead of exporting everything implicitly, and use re-export sparingly…
git:20260521.52cf94e · audit A · 3 stars
function-result SKILL.md skill
ncaq/konoka · plugins/haskell-tasuke/skills/function-result/SKILL.md · Do not discard a function's final value with return (), pure (), or void; adjust the type to return the value and let…
git:20260521.6744f8a · audit A · 3 stars
himari SKILL.md skill
ncaq/konoka · plugins/haskell-tasuke/skills/himari/SKILL.md · himari is ncaq's rio-like custom Haskell Prelude. Import it with a single `import Himari`, never `import…
git:20260614.79ad199 · audit A · 3 stars
io-monad SKILL.md skill
ncaq/konoka · plugins/haskell-tasuke/skills/io-monad/SKILL.md · Prefer MonadIO and MonadUnliftIO type classes over using IO directly, and avoid redundant liftIO. Use when writing or…
git:20260521.04da5a4 · audit A · 3 stars

Every file in ncaq/konoka

Browse by kind, by grade A, or by owner.