skills.rest
JohnWebb4
JohnWebb4COMMUNITY
Explore all skills by this author →
GitHub

technical-writer

Generate technical Markdown documents from knowledge and context.

Updated Feb 23, 2019
Search Tags:#templates#markdown#architecture-decisions#pr-description#document-generation#ticket-writing
One-click install
npx skills add https://github.com/JohnWebb4/dotfiles --skill technical-writer-johnwebb4
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: technical-writer
Source: https://github.com/JohnWebb4/dotfiles/tree/main/.cursor/skills/technical-writer
Command: npx skills add https://github.com/JohnWebb4/dotfiles --skill technical-writer-johnwebb4

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Automatically converts context and knowledge into polished, ready-to-use technical Markdown documents for tickets, PR descriptions, spikes, plans, reports, architecture decisions, RFCs, and proposals.

Core Features & Use Cases

  • Template-driven generation of well-structured Markdown from knowledge and context.
  • Dual usage as a standalone writer or as a back-end engine for other skills (e.g., write-tickets, dev-workflow-write-pr).
  • Supports multiple document types (ticket-story, ticket-bug, adr, pr-description, spike, plan, docs-feature).

Quick Start

Provide the document type and the knowledge context, then request the generated Markdown.

Frequently Asked Questions about technical-writer

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

FAQPage Schema
How do I generate markdown for architecture decision records from existing context?▼

Generate markdown for architecture decision records by providing the document type and knowledge context. The skill routes this data through templates to automatically produce structured ADRs, RFCs, and proposals.

What is the best way to automate PR description writing from development context?▼

Automate PR description writing by supplying pull request context to a template-driven markdown generator. It transforms raw development knowledge into structured, ready-to-use markdown outputs for pull requests.

Can I use a markdown generator for both ticket writing and spike documentation?▼

Yes, you can use this markdown generator for both ticket writing and spike documentation. It supports multiple structured document types including ticket-stories, ticket-bugs, spikes, and plans from provided context.

How do technical documentation templates work with raw knowledge context?▼

Technical documentation templates process raw knowledge context by routing it to specific structured output formats. This mechanism maps unstructured context into polished markdown for tickets, plans, and reports.

Does template-driven markdown generation require external dependencies for inter-skill calls?▼

Template-driven markdown generation requires no external dependencies for inter-skill calls. It operates standalone or functions as a backend engine for other workflow skills without additional packages.

Related Skills

Explore More Software Engineering Skills→
redpanda-dataredpanda-data
34

writing-shape

Transform raw markdown notes into structured articles through iterative conversational drafting.

Official
Intermediate
Eric-Pacheco95Eric-Pacheco95

release-notes

Generate Markdown release notes from merged pull requests, closed tickets, and commit history.

Community
Advanced
uutauuta
1

dev

Evaluate Git branch workflow state and route to dev-plan or dev-step.

Community
Intermediate
thomasmolthomasmol
8

pr-creation

Create draft GitHub pull requests with automated branching, committing, and Linear issue links.

Community
Intermediate