text-writer

Draft technical training chapters with frontmatter, headings, and step blocks.

Updated Dec 14, 2025
One-click install
npx skills add https://github.com/imagepit/text-lint-plugin --skill text-writer
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: text-writer
Source: https://github.com/imagepit/text-lint-plugin/tree/main/skills/text-writer
Command: npx skills add https://github.com/imagepit/text-lint-plugin --skill text-writer

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

This Skill guides building consistent and well-structured technical training materials by enforcing frontmatter, a defined page structure, and hands-on steps.

Core Features & Use Cases

  • Enforces frontmatter per chapter with title and draft fields.
  • Provides a reusable template for chapters with a {{ toc }} placeholder, an introduction, learning objectives, and learning items with :::step hands-on sections, and aまとめ.
  • References style guidelines in rules/common for writing and code blocks.

Quick Start

Write a chapter file with frontmatter including title and draft, place {{ toc }} immediately after the frontmatter, then populate the sections following the template.

Frequently Asked Questions about text-writer

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

FAQPage Schema
How do I write technical training materials with consistent markdown structure?

Technical training materials require consistent markdown structure by enforcing frontmatter with title and draft fields, placing a table of contents placeholder, and following a template with learning objectives and hands-on step sections.

What is the best way to structure a chapter for technical course materials?

Structuring a technical course chapter requires frontmatter with title and draft fields, followed by a table of contents placeholder, an introduction, learning objectives with hands-on step sections, and a summary to ensure comprehensive training material coverage.

Can I enforce frontmatter and code block rules when drafting technical documentation?

Enforcing frontmatter and code block rules when drafting technical documentation is possible by referencing style guidelines that standardize writing formats and code block structures, ensuring all training materials adhere to consistent technical documentation rules.

Do I need any dependencies to automate drafting technical training materials?

No dependencies are needed to automate drafting technical training materials; the skill operates independently to generate structured chapters with frontmatter, learning objectives, and step blocks without requiring external libraries or additional environment setup.

How do I add learning objectives and hands-on steps to markdown training materials?

Adding learning objectives and hands-on steps to markdown training materials involves using a reusable template with dedicated sections for objectives and step block directives, creating interactive learning items within the chapter structure.

Why does my technical documentation need a table of contents placeholder after frontmatter?

A table of contents placeholder is needed immediately after frontmatter in technical documentation to automatically generate chapter navigation, ensuring the training materials follow the standard template structure for consistent document organization.