writerside

Standardize semantic markup and quality checks for Markdown and XML documentation.

1|Updated Apr 3, 2026

Search Tags:#templates #linting #documentation #diagrams #markup #writerside

Ready to run

npx skills add https://github.com/nq-rdl/agent-extensions --skill writerside

💬 Prompt for ChatGPT / Claude Chat▼

Please help me install this Agent Skill.
Skill: writerside
Source: https://github.com/nq-rdl/agent-extensions/tree/main/skills/writerside
Command: npx skills add https://github.com/nq-rdl/agent-extensions --skill writerside

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes references (resource) components.

What problem does it solve?

Writerside standardizes semantic markup, topic structure, and quality checks to help teams deliver well-structured documentation across Markdown and semantic XML topics, with consistent navigation, diagrams, and templates.

Core Features & Use Cases

Semantic markup reference and validation for both Markdown (.md) and Semantic XML (.topic) content.
Navigation, TOC integration, cross-topic references, and Docker-based builds for consistent output.
Built-in inspections, documentation quality tooling, and style-guide support to enforce consistency across instances.

Quick Start

Open a Writerside project in JetBrains IDE and start modeling topics and navigation, then run the Docker-based builder to generate the HTML output.

Frequently Asked Questions about writerside

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

FAQPage Schema

How do I enforce consistent semantic markup across Markdown and XML documentation topics?▼

Semantic markup consistency across Markdown and XML topics is enforced through built-in inspections and validation rules. These quality tooling checks standardize topic structure, cross-topic references, and style-guide compliance across all documentation instances.

What's the best way to structure technical documentation navigation and cross-topic references?▼

Technical documentation navigation is structured using a hierarchical topic model with TOC integration and cross-topic references. This ensures predictable builds and consistent output across mixed Markdown and semantic XML content instances.

How do I build documentation projects with Docker for predictable HTML output?▼

Documentation projects are built for predictable HTML output using a Docker-based builder. After modeling topics and navigation in a JetBrains IDE, running the Docker builder generates consistent HTML output across all instances.

Can I use built-in inspections and linting to validate documentation quality in a JetBrains IDE?▼

Yes, built-in inspections and documentation quality tooling validate content directly within a JetBrains IDE. Linting checks enforce style-guide support, semantic markup rules, and cross-topic reference integrity for both Markdown and XML topics.

When do I need semantic XML topics instead of just Markdown for technical documentation?▼

Semantic XML topics are needed when technical documentation requires strict semantic markup, complex diagrams, and structured topic hierarchy beyond standard Markdown. Mixing both formats allows predictable builds with consistent navigation and quality checks.

Why does my documentation build fail during cross-topic reference validation?▼

Documentation builds fail during cross-topic reference validation when built-in inspections detect broken links or inconsistent semantic markup. Enforcing a structured topic hierarchy and style-guide compliance resolves these reference and markup errors.