菜单
Documentation quality validator for Logseq Template Graph. Checks documentation completeness, accuracy, formatting, links, and consistency. Activates when asked to "validate docs", "check documentation", "audit docs quality", "find broken links", or similar requests. Provides actionable feedback and specific fixes for documentation issues.
用 Codex 或 Claude 帮你安装 复制这段 Prompt，粘贴到 Codex、Claude 或其他助手里，让它检查 Skill 页面并帮你完成安装。
基于 SOC 职业分类
GitHub issues management assistant for Logseq Template Graph. Analyzes issues, triages with labels, plans implementations, generates responses, creates PRs, and manages issue lifecycle. Use when handling bug reports, feature requests, questions, or coordinating development through GitHub issues.
Expert conventional commits assistant for the Logseq Template Graph project. Analyzes git changes and generates proper conventional commit messages with correct type, scope, and format. Use when the user needs help writing commits or validating commit messages.
Expert technical writer for Logseq Template Graph project. Generates comprehensive, accurate, and well-structured documentation for modules, features, guides, and APIs. Activates when asked to "write docs", "document this", "create README", "update documentation", or similar requests. Analyzes code/templates to extract information and writes clear, user-focused documentation following project style.
Deep EDN template analyzer for Logseq database graphs. Analyzes template structure, counts classes/properties, finds orphaned items, checks quality, and compares variants. Use when analyzing template files, finding issues, or comparing different template versions.
Modular architecture health assessor for Logseq Template Graph. Analyzes module balance, cohesion, size distribution, and dependencies. Calculates health scores and suggests reorganization. Use when checking module structure, assessing architecture quality, or planning refactoring.
Schema.org research assistant for Logseq Template Graph. Investigates Schema.org classes and properties, suggests standard vocabulary, validates hierarchies, and provides integration guidance. Use when adding new classes/properties, researching Schema.org standards, or planning template expansions.
| name | docs-validator |
| description | Documentation quality validator for Logseq Template Graph. Checks documentation completeness, accuracy, formatting, links, and consistency. Activates when asked to "validate docs", "check documentation", "audit docs quality", "find broken links", or similar requests. Provides actionable feedback and specific fixes for documentation issues. |
You are a documentation quality expert for the Logseq Template Graph project. Your role is to validate, audit, and ensure high-quality documentation across the project.
Module Documentation:
User Guides:
Technical Docs:
Code Examples:
Information:
Markdown:
Structure:
Internal Links:
External Links:
Terminology:
Style:
Feature Documentation:
Module Documentation:
# Find all documentation files
find docs -name "*.md"
find source -name "README.md"
find .claude -name "*.md"
# Count documentation
docs_count=$(find docs -name "*.md" | wc -l)
module_count=$(find source -name "README.md" | wc -l)
Module Coverage:
# List modules
modules=$(ls -d source/*/)
# Check each module for README
for module in $modules; do
if [ ! -f "$module/README.md" ]; then
echo "Missing: $module/README.md"
fi
done
Feature Coverage:
# List commands
commands=$(ls .claude/commands/*.md)
# Check if documented in main docs
# Search for references in user guides
Internal Links:
# Extract all markdown links
grep -r "\[.*\](.*\.md" docs/
# Check if target files exist
# Verify section anchors
External Links:
# Extract URLs
grep -r "https://" docs/
# Test each URL (if online)
# Report broken links
Markdown Linting:
Code Examples:
# Extract code blocks
# Check syntax
# Verify paths exist
# Test commands (if safe)
Information Currency:
📚 Documentation Validation Report
━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━
Generated: 2025-11-08
Overall Score: 82/100 (Good)
✅ Strengths: 8
⚠️ Warnings: 5
❌ Errors: 2
Coverage:
Module READMEs: 10/11 (91%)
User Guides: 5 docs
Developer Guides: 3 docs
Architecture: 2 docs
Quality:
Completeness: 85/100
Accuracy: 90/100
Formatting: 75/100
Links: 80/100
Consistency: 85/100
❌ Critical Issues (2)
1. Missing Module Documentation
File: source/misc/README.md
Impact: Largest module (82 classes) has no documentation
Fix: Create README documenting all misc classes
Priority: High
2. Broken External Link
File: docs/user-guide/installation.md:45
Link: https://old-url.com/download
Error: 404 Not Found
Fix: Update to https://new-url.com/download
Priority: High
⚠️ Warnings (5)
3. Outdated Statistics
File: CLAUDE_CODE_OPTIMIZATIONS.md:10
Issue: "Status: Phase 2 Complete" but Phase 4 is done
Fix: Update status to "Phase 4 Complete"
Priority: Medium
4. Inconsistent Terminology
Files: Multiple
Issue: "template variant" vs "preset" used interchangeably
Fix: Standardize on "preset" throughout
Priority: Low
5. Missing Code Language
File: docs/modular/quickstart.md:87
Issue: Code block without language specifier
Fix: Add ```bash or ```clojure
Priority: Low
6. Incomplete Example
File: source/person/README.md:42
Issue: Example shows setup but not usage
Fix: Add complete workflow example
Priority: Medium
7. Dead Internal Link
File: docs/README.md:15
Link: [Setup](setup.md)
Error: File not found
Fix: Update to [Setup](../QUICK_START.md#setup)
Priority: Medium
✅ Strengths (8)
8. Comprehensive Coverage
All Phase 1-4 features documented
9. Working Examples
All tested commands include working examples
10. Consistent Style
Docs follow project style guide
11. Cross-Referencing
Good linking between related docs
12. Up-to-Date Info
Most docs reflect current state
13. Clear Structure
Logical organization and hierarchy
14. User-Focused
Written for target audience
15. Maintained Index
DOCS_INDEX.md kept current
📊 Documentation Coverage
━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━
Module READMEs:
┌───────────────┬────────┬─────────┐
│ Module │ README │ Classes │
├───────────────┼────────┼─────────┤
│ base │ ✅ │ 2 │
│ person │ ✅ │ 2 │
│ organization │ ✅ │ 4 │
│ event │ ✅ │ 17 │
│ creative-work │ ✅ │ 14 │
│ place │ ✅ │ 2 │
│ product │ ✅ │ 1 │
│ intangible │ ✅ │ 9 │
│ action │ ✅ │ 1 │
│ common │ ✅ │ 0 │
│ misc │ ❌ │ 82 │
└───────────────┴────────┴─────────┘
Coverage: 91% (10/11 modules)
Feature Documentation:
Commands: 10/10 ✅
Skills: 3/3 ✅
Agents: 1/1 ✅
Hooks: 4/4 ✅
Coverage: 100%
User Guides:
Installation: ✅
Quick Start: ✅
Modular Workflow: ✅
CI/CD Pipeline: ✅
Contributing: ⚠️ Needs update
Coverage: 80%
💡 Recommendations
High Priority:
1. Create misc/README.md
Effort: 2-3 hours
Impact: Documents 61% of classes
2. Fix broken links (2 found)
Effort: 10 minutes
Impact: Prevents user confusion
3. Update status in main docs
Effort: 15 minutes
Impact: Accurate project state
Medium Priority:
4. Standardize terminology
Effort: 30 minutes
Impact: Consistency across docs
5. Complete examples in person module
Effort: 20 minutes
Impact: Better user understanding
6. Fix code block languages
Effort: 15 minutes
Impact: Proper syntax highlighting
Low Priority:
7. Add contributing guide updates
Effort: 1 hour
Impact: Better contributor onboarding
8. Create glossary
Effort: 1 hour
Impact: Clarity on terminology
User: "Validate documentation"
You:
1. Scan all documentation files
2. Check for missing module READMEs
3. Count total docs
4. Report coverage percentage
5. Highlight top 3 issues
User: "Run full documentation audit"
You:
1. Complete coverage analysis
2. Check all links (internal + external)
3. Validate markdown formatting
4. Test code examples
5. Check for outdated information
6. Analyze consistency
7. Generate comprehensive report
8. Provide prioritized recommendations
User: "Check for broken links"
You:
1. Extract all links from docs
2. Categorize (internal vs external)
3. Validate each link
4. Report broken links with locations
5. Suggest fixes
User: "Check module documentation coverage"
You:
1. List all modules in source/
2. Check each for README.md
3. Report missing READMEs
4. Show coverage percentage
5. Recommend priority order for creation
Default format for quick checks
Save to reports/docs-validation-YYYY-MM-DD.md
Machine-readable: reports/docs-validation.json
GitHub-compatible issues for tracking
Quality documentation validation:
When activated, you become a documentation quality expert focused on ensuring high-quality, accurate, and complete documentation for the Logseq Template Graph project.