Communityライティング&編集github.com

report-copyedit

Copyedit and line-edit technical and scientific writing (reports, theses, lab reports, papers, specifications, design docs, technical documentation) for clarity, precision, consistent terminology and correct notation, without changing the technical content. Use this whenever someone asks to copyedit, proofread, line-edit, tighten, simplify, polish the language of, improve the readability or flow of, or "fix the English in" a technical text, AsciiDoc, LaTeX or Markdown file; to make terms, units, abbreviations, hyphenation or capitalization consistent; or to build a style sheet from an existing draft. For a whole-document pre-submission review (structure, figures, references, checklist) use report-review instead.

report-copyedit とは?

report-copyedit is a Claude Code agent skill that copyedit and line-edit technical and scientific writing (reports, theses, lab reports, papers, specifications, design docs, technical documentation) for clarity, precision, consistent terminology and correct notation, without changing the technical content. Use this whenever someone asks to copyedit, proofread, line-edit, tighten, simplify, polish the language of, improve the readability or flow of, or "fix the English in" a technical text, AsciiDoc, LaTeX or Markdown file; to make terms, units, abbreviations, hyphenation or capitalization consistent; or to build a style sheet from an existing draft. For a whole-document pre-submission review (structure, figures, references, checklist) use report-review instead.

対応~Claude Code~Codex CLI~Cursor
npx skills add https://github.com/larsw/report-writing-skills/tree/HEAD/skills/report-copyedit

Installed? Explore more ライティング&編集 skills: steipete/notion, langchain-ai/langchain, bytedance/podcast-generation · View all 6 →

お気に入りのAIに質問する

このエージェントスキルを事前に読み込んだ状態で新しいチャットを開きます。

ドキュメント

Technical copyedit

Clarity and unambiguity beat every style rule. A technical text is read by someone with general technical knowledge and no knowledge of the project, who cannot ask the author. A copyedit removes everything that makes that reader stumble, guess or misread, and changes nothing the author meant.

Method follows H. Hering, How to Write Technical and Scientific Reports (3rd ed., Springer 2025), Sects. 2.6, 3.6–3.8.

Set up

  1. Rules. Look for the venue's style guide and the project's style sheet (style-sheet.adoc or similar). They override the defaults here. If there is no style sheet, build one while editing (see Output).
  2. Level of edit. Match the request; if unclear, use medium and say so.
    • light ("proofread", "check for typos", "just fix mistakes", "don't rewrite"): fix errors only: spelling, grammar, punctuation, notation (number–unit spacing, "Fig. 4"). Anything that is a matter of style or consistency rather than an error (unifying two terms, unit repetition in ranges, a better preposition) goes into a short "optional suggestions" list instead of the text. The author asked for their text back with the mistakes gone, not for an improved version.
    • medium (default; "copyedit", "polish", "tighten"): light + sentence-level clarity: split overlong sentences, fix unclear references, replace vague words, unify terms, remove filler.
    • heavy ("rewrite for clarity", "line-edit"): medium + reorder sentences within paragraphs, merge or split paragraphs, add introductory and connecting sentences.
  3. Keep the author's conventions where they are consistent and acceptable: language variety (British/American), voice (impersonal/passive or active "we"), citation style, one-sentence-per-line source layout. Change a convention only if the style sheet or the user says so.

Passes

Work in this order; each pass makes the next one easier.

1. Survey (no edits yet)

Read the whole text (all included files) once and collect:

  • Terms: every name for each part, process, quantity and variant. Variants for one thing ("test rig / test bench / setup") must become one term. Choose the term from the style sheet; otherwise the most precise one that names the function ("retaining plate", not "plate"). Ask only when the choice would change the meaning.
  • Abbreviations: where each is first used and whether it is defined there.
  • Notation: units, number formats, symbols, hyphenation and capitalization variants.

2. Sentences and paragraphs (medium and heavy)

Apply references/style-rules.md. The rules that matter most:

  • At most about 25–30 words per sentence; one new fact per sentence; one main clause plus at most one or two subordinate clauses. Split long sentences and make the logical link explicit (because, therefore, if … then, however).
  • Clear references: every "it", "this", "which" points unambiguously to one noun. "The current I flows through the resistance R, which is small" → "The current I flows through the resistance R. R is small."
  • Vague qualifiers (rather complex, much more linear, very fast, relatively low, significant without statistics): use the number if the text has it elsewhere; otherwise insert an author query asking for it; delete the qualifier if it carries nothing.
  • Nominalizations and filler: "perform an evaluation of" → "evaluate"; "due to the fact that" → "because"; "it should be noted that" → delete.
  • Name things by function, never "the design", "the system", "variant 2" when a real name exists.
  • Passive voice is fine in impersonal reports, but the actor must be clear: "the valve is closed" → "the valve is closed by the controller" when it matters who or what does it.
  • No telegraphic style (dropped verbs and articles), no double negatives, no emotional or colloquial wording ("works really nicely").
  • The first sentence under a heading must stand on its own, not continue the heading.
  • Paragraphs: one topic, at most about six sentences, no strings of one-sentence paragraphs.
  • Heavy edit only: add missing introductory sentences before figures, tables and lists and at section starts; add connecting sentences at section ends. At medium level, query them instead.

3. Words and notation

Apply references/typography.md and, for numbers, units and formulas, references/formulas-units.md: space between number and unit, italic quantity symbols, en dash or "to" for ranges (one of them), real minus sign, consistent decimal marker, abbreviation defined at first use, hyphenation of compound modifiers, capitalization of headings and captions, parallel list items, no space inside brackets or before punctuation.

4. Consistency sweep

For every decision in the style sheet, search the whole document (all files, captions, tables, figure labels where editable) for the rejected variants and fix them. Variation across chapters written at different times is the most common residual error.

Never

  • Change technical meaning, values, units of measured data, or the strength of a claim ("may" → "will", "suggests" → "proves").
  • Invent a number, source, or fact to replace a vague word. Query instead.
  • Introduce synonyms for elegance.
  • Edit inside code listings, literal blocks, math source, URLs, citation keys, anchor IDs or \labels, attribute entries, include directives, LaTeX command names, environments, the preamble or PlantUML sources (except label text the user asked to unify, and then only the label strings).
  • Reflow or rewrap AsciiDoc or LaTeX source more than the edit requires; small diffs are easier to review.
  • In LaTeX, keep the markup the project uses for notation (siunitx \qty, \cref, \gls, ties ~) and use it for your own fixes: "5mm" becomes \qty{5}{\milli\metre} if the document uses siunitx, otherwise 5~mm. references/typography.md lists the LaTeX forms.

Author queries

When only the author can resolve something (missing value, ambiguous meaning, two terms that may or may not be the same thing, a claim that seems unsupported), leave a query instead of guessing:

  • In AsciiDoc files: a comment line directly above the paragraph: // ###AQ: Which deviation did the old sensor have (max. %)? Needed to replace "much more linear".
  • In LaTeX files: the same as a % comment: % ###AQ: Which deviation did the old sensor have (max. %)?
  • In pasted text: numbered markers [AQ1] in the text and the questions listed after it.

If the report-review skill is installed, its linter lists ### markers, so open queries cannot slip into the final version.

Output

Files in a repository: edit the files directly. Then report:

  1. What level of edit you applied and which conventions you kept.
  2. Changes grouped by type with rough counts (e.g. "split 14 long sentences; unified 'test rig' (was also 'test bench', 'setup'); defined 5 abbreviations at first use; fixed 22 number–unit spacings").
  3. Three to five representative before/after pairs, so the author sees the kind of change.
  4. All author queries with file:line. Keep copyedit queries (meaning, missing values, ambiguous terms) separate from things you noticed outside the copyedit's scope (structure, contradictions with other chapters, doubtful technical claims); list the latter briefly under "Noticed, not edited" so they are not lost but do not drown the queries.
  5. Style-sheet decisions: update style-sheet.adoc if it exists; otherwise show the decision list and offer to save it (template: references/style-sheet-template.adoc).

Pasted text: return the edited text first, then the same report (items 2–5) in compact form. If the user wants to approve changes first, give a table of Before | After | Why for the substantive edits instead of applying them.

Keep the report short. The author wants the edited text and the decisions, not a lecture on style.

Individual skills in this repo

This repo contains 4 individual skills — each has its own dedicated page.

report-drafting

Draft the content of technical and scientific reports - introduction, state of the art, methods/test setup, results, discussion, summary/conclusions, abstract, appendices - together with their figures, tables, PlantUML diagrams, charts, formulas, computations and citations, in AsciiDoc, LaTeX or plain prose. Use this whenever someone asks to write, draft, expand, or turn notes, data, measurements, code or bullet points into a section of a report, thesis, lab report, design report, project report or technical documentation; to create or improve a figure, diagram, chart, caption, table or evaluation/decision matrix for one; to set up equations or a load calculation; or to add citations and a reference list - even if they just say "write up these results".

report-outline

Plan a technical or scientific report before and while drafting it - analyze the assignment, write and test title variants, condense the core message into one sentence, grow a 4-point then 10-point then detailed outline, pick a structure pattern for the report type (lab/test report, design report, project report, thesis, manual, research paper), and set up a style sheet and an AsciiDoc or LaTeX skeleton. Use this whenever someone is starting or reorganizing a report, thesis, lab report, design report, project report or technical documentation and asks for an outline, structure, table of contents, chapter plan, section order, working title or title ideas, or asks "how should I organize this?" - and also to check an existing outline or ToC for logic (lone subsections, unequal siblings, vague headings).

report-presentation

Turn a technical report, thesis or project into a talk and slide deck, review and polish existing slides or a talk script, and prepare rehearsal, delivery and Q&A - including thesis defenses, project status talks, conference talks and 3-10 minute short statements. Builds decks in asciidoctor-reveal.js (AsciiDoc) or LaTeX Beamer with PlantUML diagrams and speaker notes, and checks them with a deck statistics script. Use this whenever someone asks to make slides, a deck, a presentation or a talk from a report or results, to review, critique or improve slides or speaker notes, to fit a talk into N minutes, to plan a defense or a status update, or to prepare for questions after a talk.

report-review

Review a technical or scientific report, thesis, lab report, design report or technical document as a whole before submission or release - structure and logic, completeness, clarity for a reader without project knowledge, figures and tables, citations and reference list, formulas and notation, terminology consistency, cross-references, open TODO markers and output quality - using a mechanical AsciiDoc/LaTeX linter plus a checklist, and produce a prioritized findings report with concrete fixes. Use this whenever someone asks to review, check, audit, assess, give feedback on, "look over", or do a final/pre-submission/QA pass on a report or thesis (AsciiDoc, LaTeX, Markdown, PDF or Word), asks "is this ready to hand in?", or wants supervisor-style feedback on a draft chapter.

関連スキル