vf-doc-review

Audit Veryfront documentation for accuracy, structure, and completeness.

9|1|Updated Nov 21, 2025
One-click install
npx skills add https://github.com/veryfront/veryfront-code --skill vf-doc-review
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: vf-doc-review
Source: https://github.com/veryfront/veryfront-code/tree/main/.claude/skills/vf-doc-review
Command: npx skills add https://github.com/veryfront/veryfront-code --skill vf-doc-review

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes scripts (resource) and references (resource) components.

What problem does it solve?

This Skill reviews Veryfront's user-facing documentation, ensuring content accuracy, structure, professional technical writing, and completeness of the Getting Started guide.

Core Features & Use Cases

  • Content Accuracy: Audits API symbols, file paths, env vars, CLI commands, and cross-links for correctness.
  • Structure: Checks frontmatter, headings, code fences, and cross-links in guide index.
  • Voice: Ensures professional technical writing without AI-generated marketing prose.
  • Completeness: Validates Getting Started flow to ensure it works end-to-end.

Quick Start

Run the skill to review the Veryfront documentation.

/vf-doc-review

Frequently Asked Questions about vf-doc-review

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I audit technical documentation for accuracy and completeness?

To audit technical documentation for accuracy and completeness, review API references, file paths, CLI commands, and cross-links, then validate the Getting Started guide end-to-end to ensure it works correctly. This process catches incorrect symbols and broken links.

What does a documentation review check for in technical writing quality?

A documentation review for technical writing quality checks frontmatter, headings, and code fences for correct structure, while ensuring the voice remains professional without AI-generated marketing prose. This maintains clear and reliable developer guides.

How can I verify that my Getting Started guide works correctly?

To verify that your Getting Started guide works correctly, validate the entire flow end-to-end to ensure it functions without missing steps. This completeness check confirms new users can successfully follow the setup instructions without errors.

Does this documentation review tool check API references and CLI commands?

Yes, this documentation review tool checks API references and CLI commands by auditing their symbols and paths for correctness. It ensures that all technical references in the documentation accurately reflect the actual system.

How do I check documentation structure for frontmatter and code fence issues?

To check documentation structure for frontmatter and code fence issues, run an automated review that scans headings, cross-links, and formatting. This ensures your technical guides maintain proper hierarchical organization and valid syntax.