structured-writing

Solid

Structure and revise detailed instructions, plans, reports, documentation, and bullet lists so their hierarchy and relationships are clear. Use when drafting or reorganizing multi-part prose, especially when deciding between headings, topic bullets, supporting nested bullets, and independent flat items. Do not use for short answers, code-only output, or machine-readable data unless the user also requests prose organization.

Data & Documents 151 stars 6 forks Updated today MIT

Install

View on GitHub

Quality Score: 84/100

Stars 20%
73
Recency 20%
100
Frontmatter 20%
70
Documentation 15%
100
Issue Health 10%
50
License 10%
100
Description 5%
100

Skill Content

# Structured Writing Make the document's logical relationships visible without imposing a template on every sentence. ## Structure - Lead a detailed section with its main conclusion or topic. - Use headings to separate distinct concerns, not to decorate short text. - Use `Label: Details` when it improves scanning. Treat it as an option, not a mandatory template. - Write procedures as steps to perform when work begins and in the order that prevents problems. For example, write “In a new clone or worktree, install the hook before editing or committing,” not “Check the hook if it does not run.” - When one bullet states a topic and later bullets only support it, make the parent the topic sentence, nest supporting sentences, and use the last child as a conclusion when useful. ```text - topic sentence - support sentence - support sentence - conclusion sentence ``` - Treat consecutive sentences beginning with a pronoun such as “it” as supporting details when they refer to the preceding topic; keep a sentence with a different subject as an independent item. - Group every claim that explains the same topic under that parent, including scope, caching, and failure behavior; do not detach one merely because it describes a different aspect. - Do not leave supporting sentences in a flat list without a topic sentence. Keep bullets at one level only when each item can stand on its own as a topic sentence. - Convert procedures into ordered steps when sequence matters; k...

Details

Author
shunk031
Repository
shunk031/dotfiles
Created
10 years ago
Last Updated
today
Language
Shell
License
MIT

Similar Skills

Semantically similar based on skill content — not just same category