Verified:GitHub

writing-skills

Automate skill documentation creation and validation using the RED-GREEN-REFACTOR workflow.

Updated Nov 24, 2024

Search Tags:#quality-assurance #workflows #frontmatter #documentation-review #test-driven-development #skill-documentation

Ready to run

npx skills add https://github.com/devtitus/3D-Portfolio --skill writing-skills-devtitus

💬 Prompt for ChatGPT / Claude Chat▼

Please help me install this Agent Skill.
Skill: writing-skills
Source: https://github.com/devtitus/3D-Portfolio/tree/main/.kilocode/skills/writing-skills
Command: npx skills add https://github.com/devtitus/3D-Portfolio --skill writing-skills-devtitus

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

This Skill provides a structured, test-driven approach to authoring and validating skill documentation so it remains consistent, maintainable, and deployable across the knowledge base.

Core Features & Use Cases

Enforces a frontmatter-constrained schema (name and description) for SKILL.md.
Guides Red-Green-Refactor skill development for documentation.
Supports integration with future tests and deployment workflows to ensure quality before publishing.
Use cases include drafting new skills, updating existing ones, and verifying skill readiness prior to deployment.

Quick Start

Create a new skill directory with a SKILL.md containing a valid frontmatter and concise description.
Write the skill body following the red-green-refactor methodology and validate with test-like scenarios.
Validate that the skill can be discovered and loaded by the system.

Frequently Asked Questions about writing-skills

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

FAQPage Schema

How does test-driven development apply to skill documentation?▼

Test-driven development for skill documentation uses a Red-Green-Refactor workflow to structure drafting, review, and refinement. This methodology ensures your skill docs remain consistent, maintainable, and deployable by validating readiness through test-like scenarios before publishing.

What frontmatter is required in a SKILL.md file?▼

A valid SKILL.md file requires a frontmatter schema constrained to name and description. Enforcing this frontmatter validation ensures the skill can be properly discovered, loaded, and deployed across the knowledge base.

How do I validate skill documentation for deployment readiness?▼

You validate skill documentation readiness by applying test-like scenarios during the Red-Green-Refactor lifecycle. This verifies that your SKILL.md has clear sectioning, valid frontmatter, and can be successfully discovered and loaded by the system.

Can I use this approach to update existing skill docs instead of drafting new ones?▼

Yes, the test-driven documentation approach supports both drafting new skills and updating existing ones. It guides the refinement lifecycle to ensure your updated skill documentation maintains consistency and deployability across the knowledge base.

What is the best way to structure a SKILL.md file for consistency?▼

The best way to structure a SKILL.md file for consistency is by ensuring clear sectioning and including a frontmatter block with name and description. Adhering to this constrained schema during the refactoring phase guarantees maintainability.

Why does my skill documentation fail system discovery validation?▼

Skill documentation fails system discovery validation when it lacks the required frontmatter name and description fields or clear sectioning. Applying the Red-Green-Refactor workflow enforces these constraints to ensure successful loading and deployment.