docs-writer

Convert Jira tickets and GitHub issues into Red Hat style-compliant AsciiDoc documentation.

6|16|Updated Mar 9, 2026
One-click install
npx skills add https://github.com/flightctl/ai-workflows --skill docs-writer-flightctl
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: docs-writer
Source: https://github.com/flightctl/ai-workflows/tree/main/docs-writer
Command: npx skills add https://github.com/flightctl/ai-workflows --skill docs-writer-flightctl

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

It removes the guesswork and repetitive effort of turning Jira tickets or issue context into style-compliant AsciiDoc documentation that is ready for merge review.

Core Features & Use Cases

  • Requirement gathering: Collects the “why” and “what” from Jira, GitHub issues, or provided text and pulls linked implementation context.
  • Structure-first drafting: Plans the exact documentation placement before writing, then produces Red Hat/AsciiDoc-convention-compliant AsciiDoc.
  • Quality gates and publishing: Runs Vale (and optionally AsciiDoctor) for validation, applies changes to the repo workspace, and prepares a merge request.

Use case: You need to add or update an AsciiDoc topic in the Edge Manager docs based on a Jira change request, while ensuring Vale style compliance before creating the MR.

Quick Start

Run the docs-writer skill with your Jira ticket URL so it gathers context, plans placement, drafts AsciiDoc, validates with Vale, applies changes, and prepares a GitLab merge request.

Frequently Asked Questions about docs-writer

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

FAQPage Schema
How do I convert Jira tickets into AsciiDoc documentation?

You can automate AsciiDoc documentation generation from Jira tickets by gathering requirement context, planning repository placement, and drafting Red Hat style-compliant topics before applying changes and preparing a GitLab merge request.

What is the best way to plan documentation placement before writing AsciiDoc?

The best way to plan documentation placement is to enforce a structure-first drafting approach that determines the exact repository location for your AsciiDoc topic before writing, ensuring logical organization and requiring plan approval before content creation begins.

Does this docs workflow support Vale linting and GitLab merge requests?

Yes, this docs workflow supports Vale linting for style compliance and GitLab merge requests. It runs Vale validation to guarantee content quality, applies validated changes to the repository workspace, and prepares the merge request for review.

Can I use GitHub issues as input for technical writing automation?

Yes, you can use GitHub issues as input for technical writing automation. The Skill collects the why and what from Jira tickets, GitHub issues, or provided text, pulling linked implementation context to draft structured AsciiDoc documentation.

How do I validate AsciiDoc changes with Vale before creating a merge request?

To validate AsciiDoc changes with Vale before creating a merge request, the workflow runs Vale linting and optionally AsciiDoctor to enforce style compliance, applying changes to the repository workspace only after content quality is verified.