ワークフロー&基本ツール · cursor/plugins

technical-writing

Diátaxis構造、Google developer styleの文体、STE指示規則、Global English構文を統合した階層型テクニカルライティング標準。/technical-writing の実行時や、ドキュメント、RFC、README、PRの説明文、コミットメッセージの作成・レビュー時に使用します。

L1 基本 · ソース登録のみV1 コミット固定Dual-pass Audit
Author cursorGitHub cursor/plugins ↗Stars 7221License 仓库根无统一 LICENSE(GitHub API license 为 null);该 skill 随 pstack 插件分发,插件自带 pstack/LICENSE(MIT,Copyright (c) 2026 Lauren Tan)Commit df3fb154fb
管理レベルは Skill の能力と推奨統制措置を示すものであり、品質や安全性の認証、利用可否の判定ではありません。使用の可否はユーザーおよび管理者が決定します。Agent 環境によって制約が異なるため、自動保護を仮定しないでください。第三者製 Skill の著作権は原著作者に帰属し、利用リスクは利用者が負います。

1仕組みと動作原理

4層のライティング基準を重ね合わせ、各層に1つの問いを配置:ドキュメント種別(Diátaxis)→ 読者指向の文体(Google developer style)→ 1文あたりの情報量(STE)→ 曖昧性の排除(Global English)。段階的に絞り込み「一読して理解できる」状態を目指す。

pstack/skills/technical-writing/SKILL.md
The goal is writing a tired engineer understands on the first read. Four layers get you there, one question each: what kind of document is this, how do sentences address the reader, how much does each sentence carry, and can any sentence be read two ways. Apply all four.
4つの階層は並列のチェックリストではなく段階的な制約である:まずドキュメント種別を決定し、次に文の人称/態を管理し、1文の情報量を制限し、最後に解釈の曖昧さを完全に排除する。

各層の上に3つの大原則を規定:機能のない単語の削除、短く一般的な語の選択、ルールを守ることで文が悪化する場合はルールに固執せず文を直すこと——ルールは読者のためのものであり、機械的な文を作らないためである。

pstack/skills/technical-writing/SKILL.md
- **Cut every word that does no work.** If the sentence survives without a word, the word goes. "In order to" is "to". "It is important to note that" is nothing.
同セクション内の3つ目のルール「When a rule makes a sentence worse, fix the sentence another way or leave it alone…A sentence that follows every rule and sounds like a machine wrote it has failed.」は、この標準が教条主義に陥るのを防ぐ安全弁となっている。

Diátaxisモードの振り分け:「行動の指導か理解の深化か × 学習のためか実務のためか」の2つの問いによって、すべてのドキュメントをtutorial/how-to/reference/explanationのいずれかに分類。モードの混在は禁止し、別モードにまたがる内容はリンクで分割する。

pstack/skills/technical-writing/SKILL.md
One document, one mode. Two questions pick it: does the content inform action (doing) or understanding (thinking), and does it serve learning or work?
各モードに行動規範を提示(tutorial=「we」+命令形+早い段階での目に見える結果、how-to=手順のみ、reference=説得を含まない客観的記述、explanation=唯一見解の記述が許可される)、そして「Don't mix modes: no reference tables inside a tutorial…Split and link instead.」として締めくくる。

文レベルの規則は3つの外部仕様を直接導入し、ソースと取得日を本文に明記:Google developer style(developers.google.com/style)、STE管理言語(asd-ste100.org Issue 9 2025)、Global English(Kohl, SAS Press——Internet ArchiveおよびSASサンプル章より転写)。すべて執筆時に取得され、実行時呼び出しは行わない。

pstack/skills/technical-writing/SKILL.md
Source: diataxis.fr, fetched 2026-07-18.
4つのソースそれぞれに「Source: … fetched 2026-07-18.」の行が付与されている(diataxis.fr、developers.google.com/style、asd-ste100.org、Kohlの著書)。STEについては「The numbered rules and dictionary live in the spec PDF. The principles above are the transferable core.」と明記し、汎用的に適用可能なコア部分のみを転写していることを誠実に示している。

リポジトリの語彙規律:「コードベースこそが用語集である」——実在するシンボル名、ファイル名、コマンド名を記述し、独自のスラングや比喩表現を禁止。新たな禁止語を発見した際はunslopを直接編集せず、「禁止語→置換語」をdiff形式で提案として回答内に記述する。

pstack/skills/technical-writing/SKILL.md
The codebase is the word list. Write the real symbol, file, flag, or command name, not a synonym or a description of it.
協調の境界線が明確:「Propose a new offender and its replacement as an addition to `unslop`'s abstract-metaphor rule in your reply, with the diff. Don't edit that skill.」——用語集の所有権はunslopにあり、本スキルは提案のみを行う。

unslopと密接に連携し対象範囲を拡張:本スキルが扱うすべてのドキュメントはunslop(AI構文、冗長な穴埋め語、形式的な特徴のカタログ)によるチェックを通す。PRの説明文やコミットメッセージも執筆対象に含む(Diátaxis以外の全レイヤーを適用)。

pstack/skills/technical-writing/SKILL.md
- Apply the **unslop** skill to every doc this skill touches. That skill owns the slop-pattern catalog: AI vocabulary, filler, hedging, formatting tells.
「ドキュメントの品質」を本文からエンジニアリングの痕跡全般へと拡張:「PR descriptions and commit messages are writing too…A PR body is a briefing that a reviewer can read in under a minute.」

worked example(Before/Afterのリライト例)と8項目のレビューチェックリストを提供し、抽象的な基準を直接実行可能な検収用の問いに落とし込む。宣言的ルールにより「数値、パス、カウントは適用コミット上で真であり、再現可能なコマンドを付記すること」を要求する。

pstack/skills/technical-writing/SKILL.md
Make every count or tree claim true at the commit that lands it, and include the command that regenerates it.
Before/Afterの例では、受動態と空虚な言葉で埋め尽くされた設定手順を、実際のコマンドを含む3つの平叙文へとリライトしている。レビューチェックリストは8項目(単一モード/命令形/1文1義/削除可能な単語/指示対象の曖昧さ/1事象1名称/口語表現/シンボルや数値の真実性)で構成される。

2コア機能

01ドキュメント種別のトリアージ:Diátaxis 4モードからの単一選択 + モード混在の禁止 + モード間リンクの活用
02文レベルの標準:you/現在形、能動者の明確化、命令形、条件の先行、simply/easy/quickly/please などの使用禁止
03STE管理言語:1文1義、極端な長文の分割、曖昧さ排除のための the/a の維持、1語1義、手順における直接的な命令形、-ing 形の抑制
04Global Englishによる曖昧性排除:only/not の直前配置、連続する名詞句の分解、一意な指示代名詞、構文を支える小詞の保持、スラッシュや略語の禁止、1つの対象に対する一貫した名詞の使用
05リズムと見解のコントロール:長文と短文の緩急、1文1義≠均一な文長、モードが許容する箇所での明確な見解、無機質さより具体性の優先
06実在シンボル規律 + unslop連携 + PR/コミットへの適用 + worked example + 8項目のレビューチェックリスト

3外部依存関係

KindDependency / Endpoint
network内容来源引用(撰写期抓取的知识来源,非运行时调用):diataxis.fr
network内容来源引用(非运行时调用):developers.google.com/style
network内容来源引用(非运行时调用):asd-ste100.org(STE 规范 Issue 9, 2025)
network内容来源引用(非运行时调用):Kohl《The Global English Style Guide》(SAS Press,经 Internet Archive/SAS 样章转写)

4推奨統制措置と判定根拠

安全運用のための推奨統制措置
Agent 向け
自動ロード可能
管理者向け
ソースとバージョンの記録
判定根拠(ファイルパスと抜粋)
  • SKILL.md: 純粋なプロンプト指示およびルールテキストであり、スクリプト実行や外部影響は一切なし
監査ノート: 純粋な指示型スキル:スクリプト実行、外部ネットワーク送信、認証情報の読み取り、ローカルファイルへの書き込みを行わず、実行時のI/Oはゼロ(4層の標準および実例はすべてSKILL.md内にインラインで完結)。さらに disable-model-invocation: true により、ユーザーが明示的に呼び出した場合(/technical-writing または執筆/レビュー時)にのみトリガーされます。注意点はルールの機械的適用による文体リスクおよび静的知識の鮮度のみであり、コードレベルの危険性はありません。

5二重目の独立検証

  • [ok] 单文件零资产 — 技能目录仅 SKILL.md(含隐藏文件 glob 确认),无 references/scripts/data。
  • [ok] 四层标准与 description 对应 — 正文标题/内容与 description 四层(Diátaxis structure / Google developer style sentences / STE instruction rules / Global English syntax)一一对应;每层均给独立规则块与来源行。
  • [ok] 来源引用为静态文字、非运行时调用 — 4 处 'Source: … fetched 2026-07-18.' 均为引用标注;无 urlopen/curl/requests 等运行时拉取代码。
  • [ok] 规则内容与所引规范一致(抽样) — Google style 段 'Talk to the reader as "you", in the present tense.'、STE 段 'Split instructions longer than about 20 words and other sentences longer than about 25.'、Global English 段 'Break up long noun strings' 等与规范主旨相符;并如实声明 STE 只转写可迁移核心、完整规则在 PDF。
  • [ok] unslop 联动指向真实资产 — pstack/skills/unslop/SKILL.md 存在(glob 确认);SKILL.md 明确 'That skill owns the slop-pattern catalog'——职责划分与仓库结构一致。
  • [ok] 无运行时 IO/凭证/写入 — token 扫描仅命中来源标注行;全文无 shell/网络/文件命令。
  • [ok] 夸大检查 — 'writing a tired engineer understands on the first read' 是质量标准陈述而非可测功能承诺;worked example 与 checklist 均可直接执行,无越界承诺。
  • [ok] license/stars/commit 元数据 — GitHub API:cursor/plugins stars 7221、pushed_at 2026-09-09T08:18:30Z、license null(仓库根);pstack/LICENSE 为 MIT(Copyright (c) 2026 Lauren Tan);本地 git HEAD == pin df3fb154fb982fb83f649de8646d4af6a0cb16b3。

6結論

  • 4つの権威あるライティング仕様を段階的に実行可能な単一標準に統合し、各層に「一言の問い」を設けることで適用ハードルを下げている。
  • 透明な情報源:すべての仕様に出典と取得日が付与されており、ユーザーによる遡及確認が可能。全文転写が困難なSTEについても転写可能なコアのみを含む旨を正確に自己開示している。
  • 教条主義を防ぐ安全弁(ルールにより文が悪化する場合は別の書き方に変更)により、単なるlintチェックにとどまらない実践的な執筆で活用可能。
  • エンジニアリングの痕跡を包括カバー:PRやコミットも対象に含まれ、unslopの用語集や「コミット上で真となる数値」の要件と連携してコードレビューテキストの品質を直接向上させる。
  • ゼロI/O・依存関係なしでディレクトリごと任意の環境へ移行可能。Before/Afterの具体例により抽象的な標準を模倣可能な形に具現化している。
  • 最適な用途: ドキュメント、RFC、README、PRの説明文、コミットメッセージを一級の成果物として扱うエンジニアリングチームおよび個人。複数の標準を統合した執筆スタイルを検討しており「階層化+出典明記+具体例」の記述手法を参考にしたいスキル開発者。既存のコーディング規律(unslop/poteto-modeファミリーなど)を導入しているセッション。
    不向きな用途: 自動リライトや一括推敲パイプラインを求めるシナリオ(純粋な基準定義であり自動実行機能を持たないため、エージェントが手動で適用する必要がある)。マーケティングやクリエイティブなコピーライティングを求めるシナリオ(テクニカルライティング向けの基準であり、意見の提示はexplanationモードのみに限定される)。最新の仕様バージョンをリアルタイムでオンライン検索する必要があるシナリオ(静的なスナップショット知識に基づくため)。
    Install Agent-Ready
    ① Verified Mirror 2026-09-09
    Option A · Direct DownloadDownload technical-writing.tar.gz
    sha256: bf0a9d23048af4b7…
    Option B · Copy Guide for Agent
    install.json
    Agent はこの JSON ガイドから自動的にダウンロードして検証します。
    ② Upstream GitHub
    GitHub Repo ↗
    Pinned to commit df3fb154fb.