agentmods.dev

markdown-documentation

markdown-documentation is a skill for Claude Code, Codex from eaglesakura/agent-skills. It costs 136 tokens per session (973 once invoked), scanned A, original, MIT.

A guide for writing and updating technical Markdown documentation, such as architecture notes, rules, and knowledge bases.

In plain words
What is it for?
It is for creating or revising project docs with required sections, real code examples, knowledge-base guidance, and validation steps.
Why use it?
It gives documentation a consistent structure that later agents can search, understand, and review reliably.

Skill for Claude CodeCodex

Written for no agent in particular: nothing here depends on one.

not rated 2repo 1mo ago A scan 136 tokens original MIT

Good fit It is for creating or revising project docs with required sections, real code examples, knowledge-base guidance, and validation steps.

Compare 6 skills from other repositories ↓
Install with agentmods
npx agentmods add skills/eaglesakura/agent-skills/markdown-documentation
View source ↗ eaglesakura/agent-skills
Install

Getting it into your agent

One page per mod, every tool's command on it. A separate URL per tool would split the same page into five that compete with each other.

Any agent
npx skills add eaglesakura/agent-skills --skill markdown-documentation
Clone the repo
git clone --depth 1 https://github.com/eaglesakura/agent-skills

Made for: Claude Code, Codex.

Wrote this? Show the measurements

A badge with what this costs and how it scanned, read live from this page, so it follows the numbers instead of freezing them. Markdown for a README, HTML for a documentation site or a project page.

agentmods badge for markdown-documentation

README.md
[![agentmods](https://agentmods.dev/badge/skills/eaglesakura/agent-skills/markdown-documentation/github.svg)](https://agentmods.dev/skills/eaglesakura/agent-skills/markdown-documentation)
Your own site
<a href="https://agentmods.dev/skills/eaglesakura/agent-skills/markdown-documentation"><img src="https://agentmods.dev/badge/skills/eaglesakura/agent-skills/markdown-documentation/github.svg" alt="Measured on agentmods" height="20"></a>

Or the 80×15 button, for a site that already has a row of RSS and ATOM ones. Only the verdict fits; the numbers stay here.

agentmods 80×15 button for markdown-documentation

Your own site · 80×15
<a href="https://agentmods.dev/skills/eaglesakura/agent-skills/markdown-documentation"><img src="https://agentmods.dev/badge/skills/eaglesakura/agent-skills/markdown-documentation.svg" alt="Reviewed on agentmods" width="80" height="20"></a>
Per session 136 Skills are progressive disclosure: only the name and description are preloaded; the body loads when the skill is used.
When invoked 973 The whole file, excluding the scripts and references it only reads on demand.
Security scan A 0 findings. A grade says what 26 rules found in the file — not that it is safe.
Origin original No closer match found in the catalogue.
Token cost

What it costs to keep this loaded

Counted locally with the o200k_base tokenizer, which is exact for GPT models; Claude uses its own tokenizer and its counts differ. Treat this as one consistent yardstick across the catalogue rather than a bill. Prices are per million input tokens.

ModelPer sessionOnce invoked
Fable 5.1 $0.00136 $0.00973
Opus 5.5 $0.00054 $0.00389
Sonnet 5.5 $0.00027 $0.00195
Haiku 4.5 $0.00014 $0.00097

Measured 2mo ago against content hash 7e646bd7d72b, method: parsed. Prices are Anthropic first-party input rates as of 2026-10-07, from the pricing page.

Security

Grade A, and why

markdown-documentation scanned grade A with 0 findings against 26 rules in 11 categories — prompt injection, anti-refusal, data exfiltration, privilege escalation, supply chain, agent snooping, system-prompt leakage, SSRF and excessive agency — measured 2mo ago.

A static scan of the body, not an audit. Every finding is printed with the line that produced it so you can judge whether it matters here. A mod is markdown that instructs an agent; that is exactly why what it instructs is worth reading.

Nothing flagged

None of the 26 patterns this scan looks for appear in this file: no shell pipes, no recursive deletes, no credential paths, no hidden text, no instruction-override or anti-refusal phrasing, no agent-config snooping. That is not a guarantee, it is the absence of the things that are checkable.

packages/agentic-workspace/.apm/skills/markdown-documentation/SKILL.md · 63 lines

What it actually says

ドキュメンテーション / 技術文書の記載

技術ドキュメントの読み手は後続の実装・レビュー Agent である。 文体・必須セクション・実在コード引用を揃えることで、検索（markdown-search）とレビューが安定する。

いつ使うか / 使わないか

  • 使う: docs/ 等の技術文書、アーキテクチャ・規約・ナレッジの作成更新
  • 使わない: .ai-agent/plan/ の要件・詳細設計（engineer.*）、単なる lint 修正（markdown-fix）、探索のみ（markdown-search）

ひな形は assets/template.md を起点にする。

基本方針

  • 「である」調で簡潔に書く
  • 本文は DO / 推奨 を示し、DO NOT はナレッジベース（や example）に寄せる
  • 実装例は実在コードを優先し、架空コードで埋めない

必須構造

  1. 概要（冒頭）— 目的・役割・特徴・関連コンポーネント
  2. 原則・規則（必要な数だけ）— 各原則に次を付ける
    • ${原則名}の補足（意図・利点・注意・例外）
    • ${原則名}の実装例（良い例必須、悪い例は必要時）
  3. ナレッジベース（末尾付近、参考リンクの直前）— ### DO: / ### DO NOT:
  4. 参考リンク（Web を参照した場合）— URL は <https://...> 形式

見出しは文書内で一意にする（「補足」「実装例」の重複を避ける）。階層は最大 4、飛ばさない。

作業手順

  1. 既存コードと類似ドキュメントを調査する（必要なら先に markdown-search）
  2. テンプレートに沿いドラフトを書く
  3. コード引用・パスは references/code-blocks.md に従う
  4. 作図・パス表記は references/diagrams-and-paths.md に従う
  5. 必須セクションと見出し一意性を確認する
  6. references/lint-and-validation.md を確認し、仕上げに markdown-fix を実行する

アプリ基盤の書き方

  • 量産不要な基盤は「実装済み・詳細は参照先」と短く書く
  • 実装者が使う情報に焦点を当て、基盤内部の長文実装例は避ける

詳細リファレンス

ファイル 内容
references/code-blocks.md コード引用・テンプレート・ディレクトリツリー
references/lint-and-validation.md リンターと整合性チェック
references/diagrams-and-paths.md Mermaid・相対パス
Files

What ships with it

5 files beside SKILL.md in the same directory: the scripts, references and assets a skill reads on demand. Not counted in the per-session cost; read them before you install if any of them is executable.

Changes

What this file has done since we first saw it

Hashed on every crawl. A supply-chain change to an agent config is a question of when, not whether, so the history is kept rather than the latest state alone.

  1. 2mo ago First seen · 63 lines · 136 tokens per session scan A 7e646bd7d72b

Subscribe to this mod's changes

markdown-documentation is a skill published in the GitHub repository eaglesakura/agent-skills (2 stars, last pushed 1mo ago), licensed MIT. It adds 136 tokens to every session and 973 once invoked, about $0.0005 per session on Opus 5.5. A static security scan graded it A with 0 findings. No closer match exists in the catalogue, so it is treated as the original; first seen 2026-08-31.

Writing and docs
Related

markdown-documentation compared with skills from other repositories

markdown-documentation next to 6 skills from other repositories
ModTypeStarsLast pushLicenceScanTokensWorks with
markdown-documentationeaglesakura/agent-skillsSkill21mo agoMITA136Claude Code, Codex
imagegenopenai/codexSkill134ktodayApache-2.0A113Codex
local-ai-agentsmicrosoft/ai-agents-for-beginnersSkill79ktodayMITA200Claude Code, Codex
playwright-climicrosoft/playwrightSkill99ktodayApache-2.0A19Claude Code
systematic-debuggingobra/superpowersSkill314k4d agoMITA21Claude Code
next-cache-components-adoptionvercel/next.jsSkill143ktodayMITA95Claude Code
chat-pet-sprite-creationmicrosoft/vscodeSkill195ktodayMITA53Claude Code, Codex