technical-writing-style

Reviews and rewrites Japanese technical documents against paragraph, argumentation, and style norms.

Updated Oct 14, 2024
One-click install
npx skills add https://github.com/tktcorporation/food-shop-search --skill technical-writing-style-tktcorporation
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: technical-writing-style
Source: https://github.com/tktcorporation/food-shop-search/tree/main/.claude/skills/technical-writing-style
Command: npx skills add https://github.com/tktcorporation/food-shop-search --skill technical-writing-style-tktcorporation

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve? Japanese technical documents such as PRDs, design docs, wiki articles, reports, PR descriptions, and issues often suffer from weak paragraph structure, loose argumentation, redundant phrasing, and LLM-style filler expressions. This Skill provides a concrete norm checklist to write and proofread such documents so they read clearly and honestly for external readers. ## Core Features & Use Cases - Style Norm Inspection: Checks paragraph composition, argumentation rigor, reader cognitive load, heading quality, and redundancy across the entire document body. - LLM-Tone Elimination: Detects and removes empty LLM-style phrases such as "重要なのは", "正面から", "掘り下げる", and hollow adjectives or connectives. - Structured Review Output: Produces a findings table with location, problematic wording, category, rationale, and suggested fix, plus before/after rewrites. - Use Case: After drafting a PRD or wiki article in Japanese, run this Skill to get a categorized list of style violations and concrete rewrites that improve readability and logical precision. ## Quick Start Proofread this Japanese design document with the technical-writing-style skill and list all style violations with fixes.

Frequently Asked Questions about technical-writing-style

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

FAQPage Schema
How do I proofread a Japanese technical document for readability?▼

Run this Skill on the full document body. It inspects every heading, paragraph, list, and emphasis against norms for paragraph composition, argumentation rigor, and reader load, then returns a table of issues with concrete rewrites.

How to remove LLM-style phrases from Japanese writing?▼

The Skill flags typical LLM patterns such as "重要なのは〜である", "正面から扱う", "掘り下げる", and hollow adjectives like "不可欠" or "包括的". Each finding includes the reason it is problematic and a direct replacement.

What document types does this writing style check support?▼

It targets external-facing Japanese technical documents: PRDs, design docs, wiki articles, reports, pull request descriptions, and issues. Code snippets, logs, and config file quotes inside the document are excluded from inspection.

Does the style checker handle hedging expressions like "かもしれない"?▼

It does not mechanically convert hedging to assertions. Hedging that expresses genuine uncertainty, reader doubts, or hypotheticals is preserved; only hedging that weakens claims without justification is removed.

What are the limitations of this writing style skill?▼

It covers sentence-to-document-level style only. Content fidelity, PRD-specific logic review, and insider-language rules are delegated to other skills and rules, so it does not duplicate those checks.