Token导航 LogoToken导航TokenDH.com
研究检索external-servicegithub未标认证来源可访问许可证需确认审计提醒

ln-611-docs-structure-auditorln 611 文档结构审核员

Agent Skill

用于辅助文档、README、Markdown、说明文和内容稿件的整理与改写。它适合让 Agent 提炼结构、补齐章节、统一术语、检查链接或把零散材料整理成可读文档。使用时应保留项目已有事实、命令和路径,不要把未确认的信息写成确定结论;涉及对外文案时,还需要控制语气,避免过度营销或夸大能力。

总安装

3,920

周安装

165

GitHub Stars

441

下载量

1,373
CodexClaudeCursorGemini CLI

安装说明

本站只整理中文说明和来源信息,不托管安装包,也不代用户安装。

GitHub

来源数

2

许可证

unknown

最后核验

2026-05-01

来源状态

来源可访问

安装方式

通过对话安装

复制提示词发给支持本地命令或 Skills 的 AI 助手,先确认命令和权限,再让它执行。

请帮我安装这个 Agent Skill:ln-611-docs-structure-auditor(ln 611 文档结构审核员)
来源仓库:https://github.com/levnikolaevich/claude-code-skills
仓库路径:skills/ln-611-docs-structure-auditor
安装命令:
npx skills add https://github.com/levnikolaevich/claude-code-skills --skill ln-611-docs-structure-auditor
安装前请先检查当前环境是否支持对应 CLI,并向我确认将要执行的命令、安装目录、联网范围和文件读写权限;确认后再执行。

命令行安装

复制命令到本机终端执行。该命令会通过 npx skills 从第三方来源获取 Skill;本站只展示命令,不托管安装包,也不自动执行。

skills.shnpx skills
npx skills add https://github.com/levnikolaevich/claude-code-skills --skill ln-611-docs-structure-auditor

简介

用于文档、README 和内容稿件的整理与改写,适合提炼结构和统一术语。

  • 适用于需要补齐章节、检查链接或把零散材料整理成可读文档的场景。
  • 使用时保留项目已有事实、命令和路径,不把未确认信息写成确定结论。
  • 涉及对外文案时需控制语气,避免过度营销或夸大能力。
  • 安装前建议确认权限范围和维护状态,确保不会触发不必要的网络或文件操作。

SKILL.md

Paths: File paths (shared/, references/, ../ln-*) are relative to skills repo root. If not found at CWD, locate this SKILL.md directory and go up one level for repo root. If shared/ is missing, fetch files via WebFetch from https://raw.githubusercontent.com/levnikolaevich/claude-code-skills/master/skills/{path}.

Documentation Structure Auditor (L3 Worker)

Type: L3 Worker

Specialized worker auditing structural quality of project documentation.

Purpose & Scope

  • Audit documentation for structural quality across 8 categories
  • Scan all .md files in project, build hierarchy from AGENTS.md when present
  • Return structured findings to coordinator with severity, location, recommendations
  • Calculate compliance score (X/10) for Documentation Structure

Inputs

MANDATORY READ: Load shared/references/audit_worker_core_contract.md, shared/references/docs_quality_contract.md, shared/references/docs_quality_rules.json, and shared/references/markdown_read_protocol.md. MANDATORY READ: Load shared/references/mcp_tool_preferences.md and shared/references/mcp_integration_patterns.md

Receives contextStore with: tech_stack, project_root, output_dir.

hex-line is optional for this doc-only worker. Use it as an accelerator for large markdown outlines and targeted reads when available; otherwise continue with built-in Read/Grep/Glob/Bash.

Workflow

  1. Parse Context: Extract tech stack, project root, output_dir from contextStore
  2. Load Registry if Present: Use docs/project/.context/doc_registry.json as the first routing source when available
  3. Scan Docs: Find all .md files in project (AGENTS.md, CLAUDE.md, README.md, docs/**)
  4. Read Section-First: For larger docs, outline first, then read header markers + Quick Navigation + Agent Entry + Maintenance
  5. Build Tree: Construct hierarchy from AGENTS.md outward links when present, otherwise from CLAUDE.md
  6. Audit Categories 1-7: Run structural checks (see Audit Categories below)
  7. Collect Findings: Record each violation with severity, location (file:line), effort estimate (S/M/L), recommendation
  8. Calculate Score: Count violations by severity, calculate compliance score (X/10)
  9. Write Report: Build full markdown report per shared/templates/audit_worker_report_template.md, write to {output_dir}/611-structure.md in single Write call
  10. Return Summary: Return minimal summary to coordinator (see Output Format)

Audit Categories

#CategoryWhat to Check
1Hierarchy & LinksAGENTS.md is canonical root when present; all docs reachable via links; no orphaned files; no broken links
2Single Source of TruthNo content duplication; duplicates replaced with links to source; clear ownership
3Proactive CompressionEliminate verbose/redundant content; prose to tables; remove meaningless info; compress even under-limit files; see size_limits.md
4Requirements ComplianceCorrect header markers, correct top sections, within size limits, no illegal code blocks, stack-appropriate doc links
5Freshness IndicatorsDetect staleness signals: dates >6 months in content, unsupported API/tool references, TODO/FIXME markers, placeholder text left in place; deep fact-checking handled by dedicated worker
6Legacy CleanupNo history sections; no "was changed" notes; no unsupported info; current state only
7Stack AdaptationLinks/refs match project stack; no Python examples in.NET project; official docs for correct platform
8Import Pattern ComplianceWhen AGENTS.md exists at repo root, CLAUDE.md must contain exactly one @AGENTS.md line and a bounded harness-specific delta (≤50 lines total). Any content in CLAUDE.md that duplicates AGENTS.md is drift. See shared/references/agent_instructions_writing_guide.md for rationale

Severity Mapping

Issue TypeSeverity
Staleness indicators (old dates, unsupported refs, TODO markers)MEDIUM
Broken links, orphaned docsHIGH
Content duplicationMEDIUM
Missing compression opportunityLOW
Legacy/history contentMEDIUM
Wrong stack referencesHIGH
Import pattern drift (duplicated AGENTS.md content in CLAUDE.md, oversized stub, missing @AGENTS.md line)HIGH

Scoring Algorithm

MANDATORY READ: Load shared/references/audit_worker_core_contract.md and shared/references/audit_scoring.md.

Output Format

MANDATORY READ: Load shared/references/audit_worker_core_contract.md and shared/templates/audit_worker_report_template.md.

Write JSON summary per shared/references/audit_summary_contract.md. In managed mode the caller passes both runId and summaryArtifactPath; in standalone mode the worker generates its own run-scoped artifact path per shared contract.

Write report to {output_dir}/611-structure.md with category: "Documentation Structure" and checks: hierarchy_links, ssot, compression, requirements_compliance, freshness_indicators, legacy_cleanup, stack_adaptation, import_pattern_compliance.

Return summary per shared/references/audit_summary_contract.md.

Standalone mode still writes the same JSON summary to a worker-owned run-scoped artifact path per shared contract.

Critical Rules

MANDATORY READ: Load shared/references/audit_worker_core_contract.md.

  • Do not auto-fix: Report violations only; coordinator aggregates for user
  • Tech stack aware: Use contextStore tech_stack to apply stack-specific checks (e.g.,.NET vs Node.js doc standards)
  • No deep fact-checking: Detect staleness signals only (dates, unsupported refs, TODO markers)
  • Compress always: Size limits are upper bounds, not targets. A 100-line file instead of 300 is a win
  • No code in docs: Documents describe algorithms in tables or ASCII diagrams. Code belongs in codebase
  • Code is truth: When docs contradict code, report docs as needing update (not code)
  • Delete, don't archive: Legacy content should be removed, not moved to "archive"
  • Location precision: Always include file:line for programmatic navigation
  • Shared contract precedence: Placeholder policy, template-metadata policy, and no-code exceptions come from docs_quality_contract.md / docs_quality_rules.json

Definition of Done

MANDATORY READ: Load shared/references/audit_worker_core_contract.md.

  • contextStore parsed successfully (including output_dir)
  • All 8 structural categories audited
  • Findings collected with severity, location, effort, recommendation
  • Score calculated using penalty algorithm
  • Report written to {output_dir}/611-structure.md (atomic single Write call)
  • Summary written per contract

Reference Files


Version: 1.0.0 Last Updated: 2026-03-01

适合场景

01

用户想查找某类 Agent Skill 时

02

需要根据任务场景推荐可安装能力包时

03

需要对比不同来源的安装命令和来源信息时

能力概览

能力 1

按任务关键词查找相关 Skills

能力 2

展示可复制的安装命令

能力 3

保留来源站点、仓库和原始说明,方便继续核验

能力 4

展示第三方安全扫描或审计结果

安装后应在对应宿主中按原始 README 的触发条件使用;具体调用方式请以来源页面和 README 为准。

平台分布

Codex

32.9%
按下载量换算452

Claude

32.11%
按下载量换算441

Cursor

17.37%
按下载量换算238

Gemini CLI

9.62%
按下载量换算132

安全审计

Gen Agent Trust Hub

通过

Socket

通过

Snyk

可疑

权限和风险

external-service

该 Skill 可能调用第三方服务、云服务或外部模型 API,使用前需要确认账号、额度、数据发送范围和服务条款。

安装前确认

本站仅展示第三方公开信息,不托管安装包,不提供自动安装或运行环境。安装前应自行审查源码、依赖和命令行为。来源安全扫描存在 warning/failed 结果,不能写成本站确认安全。当前只有一个来源,正式发布前建议补源仓库或其他目录站核验。

来源信息

继续浏览同类 Skills