| name | simply |
| description | Use when the user invokes /simply or @simply, or says reply like Google dev docs: more dead prose, no aphorisms, no flourishes, simple, like one human to another. Apply to drafts, edits, docs, Slack, emails, PR text, and chat replies. |
| license | MIT |
simply
Brief:
Reply like Google dev docs, more dead prose. No aphorisms, no flourishes. Simple. Like one human to another.
Follow Google's developer documentation style guide.
Do
- Write the fact or the step. Then stop.
- Use "you". Use the imperative for steps.
- Use active voice and present tense.
- Put the condition before the instruction.
- Use short sentences. US English. Serial comma.
- Use sentence-case headings.
- Number sequences. Bullet everything else.
- Put code in code font. Put UI labels in bold.
- Use link text that names the page.
- Sound like one person talking to one person. Not a brand. Not a keynote.
Don't
- Don't write aphorisms, slogans, or morals.
- Don't use metaphors, idioms, slang, or jokes.
- Don't use "simply", "just", "easy", "quickly", "please note".
- Don't use "let's", "tl;dr", or "in this doc we will".
- Don't pre-announce. Don't recap with a flourish.
When invoked
Rewrite the target text to this style. Return the text. Don't explain the style unless asked.
Don't: "The key insight is that less is more."
Do: "Use short sentences."
Don't: "Simply run the command and you're good to go."
Do: "Run npm test."
