technical-writing

Plugin technical-writing from marketplace jml in jml/dotfiles. Commands read from the repo's manifest — 19 days ago.

Skills (5)

• reviewing-prose

  Reviews the prose of engineering text (design or intent doc, README, PR description, commit message, issue, code comment, review comment, briefing, or message) and reports findings with the quoted text, the rule, what the reader pays, and a proposed fix. Use when asked to review or tighten writing,

• writing-change-records

  Writes commit messages, pull request descriptions, issues and tickets, progress comments on issues, the text of review comments on someone else's PR or document, and replies to review comments on your own PR. Use when drafting or updating any of these, including a PR description before opening a PR,

• writing-code-comments

  Writes code comments and doc comments, and the other prose that lives in code: identifiers, error and log messages, bot messages, label descriptions, and test names. Use when adding or revising a comment or docstring, naming a function, type, or flag, writing an error message, or when a review flags

• writing-docs

  Drafts design docs, RFCs, intent docs, decision records (ADRs), READMEs, how-to guides, and reference docs. Use when asked to write one of these, to turn a discussion into a design or intent doc, or to restructure an existing design doc, README, or reference doc for a different reader. Picks the len

• writing-explanations

  Writes explanations, briefings, summaries, status updates for a person or channel, reports, announcements, and messages for a specific reader. Use when asked to explain how something works, brief someone new to an area, summarise a channel or a body of work, write a weekly report or a status update

Similar plugins