feat-docs-writing

Enforce Diataxis-based documentation standards for Feat framework docs.

63|8|Updated Dec 21, 2024
One-click install
npx skills add https://github.com/smartboot/feat --skill feat-docs-writing
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: feat-docs-writing
Source: https://github.com/smartboot/feat/tree/main/.roo/skills/feat-docs-writing
Command: npx skills add https://github.com/smartboot/feat --skill feat-docs-writing

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes references (resource) components.

What problem does it solve?

This Skill ensures that all documentation for the Feat framework adheres to a consistent, high-quality standard, making it easier for developers to understand and use the framework.

Core Features & Use Cases

  • Diataxis Framework Adherence: Organizes content into Tutorials, How-To Guides, Explanations, and References.
  • Content Boundary Enforcement: Prevents duplication and ensures information is presented logically and progressively.
  • Code Example Standardization: Guarantees code examples are functional, JDK 8 compatible, and sourced from reliable modules.
  • Use Case: When writing a new guide on Feat's asynchronous programming model, use this Skill to structure the content, ensure code examples are correct, and link appropriately to related concepts like the event loop.

Quick Start

Apply the feat-docs-writing skill to ensure the documentation for the new Feat Cloud controller feature follows the established standards.

Frequently Asked Questions about feat-docs-writing

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

FAQPage Schema
How do I structure Feat framework documentation using the Diataxis framework?

To structure Feat documentation using the Diataxis framework, organize content into four distinct types: tutorials, how-to guides, explanations, and references. This approach enforces content boundaries, prevents duplication, and ensures information is presented logically and progressively.

What are the content standards for code examples in Feat technical writing?

Code examples in Feat technical writing must be functional, JDK 8 compatible, and sourced from reliable modules. Standardizing code examples ensures developers can successfully understand and implement the Feat framework without encountering environment or syntax errors.

Where should I place new documentation files for the Feat framework?

New documentation files for the Feat framework should be placed within the `pages/src/content/docs` directory. Organizing content in this specific location allows the documentation standards skill to enforce formatting, content boundaries, and code example quality across the project.

Does the Feat documentation writing standard support asynchronous programming guides?

Yes, the Feat documentation standard supports asynchronous programming guides by helping structure the content, verifying code example correctness, and linking appropriately to related concepts like the event loop. This ensures complex asynchronous topics are explained clearly and logically.

How do I prevent content duplication when writing Feat framework guides?

To prevent content duplication when writing Feat framework guides, enforce strict content boundaries based on the Diataxis framework. This ensures information is presented logically and progressively, separating learning-oriented tutorials from problem-solving how-to guides and reference material.