writer

Write and revise Markdown and KDoc documentation with navigation sync.

2|Updated May 28, 2021
One-click install
npx skills add https://github.com/SpineEventEngine/validation --skill writer-spineeventengine
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: writer
Source: https://github.com/SpineEventEngine/validation/tree/main/.agents/skills/writer
Command: npx skills add https://github.com/SpineEventEngine/validation --skill writer-spineeventengine

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes assets (resource) components.

What problem does it solve?

This Skill helps you keep documentation accurate, well-structured, and easy to navigate, so contributors and users can find answers quickly and follow the right workflows without guesswork.

Core Features & Use Cases

  • Docs authoring and restructuring: Create or update README files, docs pages, and KDoc with improved clarity and organization.
  • Navigation and version sync: Maintain sidenav.yml consistency with docs/data/versions.yml and update only the current documentation version unless explicitly instructed otherwise.
  • Convention compliance and readability: Follow local documentation guidelines for formatting, link style, and actionable structure.

Quick Start

Update the relevant Markdown docs and keep the matching documentation navigation files synchronized for the current docs version.

Frequently Asked Questions about writer

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

FAQPage Schema
How do I keep documentation navigation in sync with current versioning?

Documentation navigation stays in sync by aligning `sidenav.yml` entries with `docs/data/versions.yml` and updating only the current documentation version. This process maintains navigation consistency across releases.

What is the best way to restructure Markdown docs and KDoc for developer experience?

The best way to restructure Markdown docs and KDoc is to revise content for improved clarity and organization while following local documentation guidelines. This ensures user-facing and developer-facing documentation remains accurate and readable.

Does this documentation writer update all versions or just the current docs version?

By default, it updates only the current documentation version unless explicitly instructed otherwise. This targeted approach preserves historical doc structure while applying necessary updates to active releases.

How do I create new troubleshooting guides that follow repository documentation conventions?

Create new troubleshooting guides by drafting Markdown pages that follow local documentation guidelines for formatting, link style, and actionable structure. This ensures new content maintains repository convention compliance.

Can I use this to update KDoc and align it with existing Markdown documentation?

Yes, you can update KDoc and align it with existing Markdown documentation. It writes and revises developer-facing KDoc to ensure alignment with repository documentation conventions and current workflows.

What are the limitations when updating historical doc structure?

The main limitation is that it preserves historical doc structure and only updates the current documentation version by default. Overriding this to modify older versions requires explicit instructions during the documentation update.