technical-writer

Name: technical-writer
Availability: InStock
Author: DomainLang

Write and maintain DomainLang documentation for user guides, API references, and grammar hover text.

16|Updated Jan 24, 2026

Search Tags:#documentation #grammar #readme #guides #tutorials #JSDoc

Ready to run

npx skills add https://github.com/DomainLang/DomainLang --skill technical-writer-domainlang

💬 Prompt for ChatGPT / Claude Chat▼

Please help me install this Agent Skill.
Skill: technical-writer
Source: https://github.com/DomainLang/DomainLang/tree/main/.github/skills/technical-writer
Command: npx skills add https://github.com/DomainLang/DomainLang --skill technical-writer-domainlang

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

This Skill equips you to produce clear, accurate documentation for DomainLang, including user guides, API docs with JSDoc, grammar hover help, and README updates, aligned with the current implementation.

Core Features & Use Cases

Write user guides and tutorials that explain concepts, workflows, and models.
Document APIs with JSDoc, including examples and parameter/types descriptions.
Create grammar documentation for hover tooltips and language references.
Produce code samples and illustrative examples that reflect the actual codebase.
Keep documentation in sync with implementation as features evolve.

Quick Start

Activate when you are writing or reviewing documentation, creating JSDoc blocks, or updating examples. For public docs in /site, pair with site-maintainer.

Frequently Asked Questions about technical-writer

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

FAQPage Schema

How do I write API documentation with JSDoc that accurately reflects my codebase?▼

To write API documentation with JSDoc, this Skill generates parameter descriptions and code examples that align with the current source implementation. It ensures your JSDoc blocks accurately reflect types and workflows without speculative entries.

What is the best way to keep user guides and tutorials in sync with evolving code?▼

Keeping user guides in sync requires reviewing documentation against the actual implementation during feature updates. This Skill updates tutorials and illustrative examples to match the current codebase, preventing outdated workflow descriptions.

How do I create grammar documentation for hover tooltips and language references?▼

Creating grammar documentation for hover tooltips involves defining syntax rules and language references based on the current implementation. This Skill extracts and formats grammar specifics to generate accurate hover text for your language.

Can I use this for documenting public site content under the /site directory?▼

Yes, you can document public site content under the /site directory by pairing this Skill with the site-maintainer. It ensures public guides and examples align with the source code while coordinating content updates effectively.

Why does my README documentation contain speculative examples that don't match the code?▼

README documentation contains speculative examples when written without checking the actual implementation. This Skill prevents this by requiring accurate reflection of current grammar, code examples, and source alignment during updates.

Do I need a separate tool to generate code samples for my API references?▼

You do not need a separate tool for code samples, as this Skill produces illustrative examples directly from the actual codebase. It generates API references with JSDoc and code snippets that reflect the current implementation.