flowfile-docs-review

Verifies and maintains editorial standards, style guides, and persona-based navigation for technical documentation.

340|27|Updated Nov 9, 2024
One-click install
npx skills add https://github.com/Edwardvaneechoud/Flowfile --skill flowfile-docs-review
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: flowfile-docs-review
Source: https://github.com/Edwardvaneechoud/Flowfile/tree/main/.claude/skills/flowfile-docs-review
Command: npx skills add https://github.com/Edwardvaneechoud/Flowfile --skill flowfile-docs-review

SYSTEM DOCUMENTATION & REQUIREMENTS

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

What problem does it solve?

This Skill maintains the editorial standard, style, and persona-based navigation for Flowfile's documentation site, ensuring consistency and quality across all pages.

Core Features & Use Cases

  • Style and Voice Consistency: Enforces house style rules, such as declarative tense, second-person voice, and no inline styling.
  • Persona Navigation: Organizes documentation by audience, providing clear paths for different user personas.
  • Verification: Ensures every claim in the documentation is fact-checked against source code.
  • Example Contract: Defines a standard for examples and templates, ensuring they are accurate and testable.
  • Review Process: Provides a checklist for reviewing documentation changes for quality and consistency.

Quick Start

Run the 'flowfile-docs-review' skill to initiate an editorial pass over the Flowfile documentation.

Frequently Asked Questions about flowfile-docs-review

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

FAQPage Schema
How do I enforce a consistent style guide across technical documentation?

To enforce a consistent style guide across technical documentation, apply automated editorial standards that check for declarative tense, second-person voice, and restrict inline styling. This ensures uniform voice and formatting consistency across all content pages.

How do I fact-check documentation against source code?

Fact-checking documentation against source code requires a verification process that cross-references every technical claim in your docs with the actual implementation. This ensures all documented features, functions, and behaviors are accurate and testable against the codebase.

What is persona-based navigation in a documentation site?

Persona-based navigation organizes technical documentation by audience type, providing clear, dedicated paths for different user personas. This ensures readers quickly find relevant information tailored to their specific roles and technical context.

How do I review documentation changes for quality and consistency?

Reviewing documentation changes for quality and consistency involves running an editorial pass using a dedicated checklist. This verifies style guide adherence, validates example contracts, and ensures persona navigation remains intact.

What is the best way to standardize examples and templates in technical docs?

Standardizing examples and templates in technical docs requires defining an example contract that ensures all provided samples are accurate and testable. This maintains reliability and consistency across documentation pages.