Skip to content
Back to search

report-writing-skills

MarketplaceWorks with Claude CodeGitHub

Agent skills for planning, drafting, copyediting, reviewing and presenting technical reports (AsciiDoc, reveal.js, PlantUML). Based on Hering's How to Write Technical and Scientific Reports.

Safety scan

A static text scan, not a guarantee. Select the badge to see what was scanned and every finding.

Checked today
Badge for your README
findsafeskills safety rating

Markdown

[![findsafeskills safety rating](/api/listings/larsw--report-writing-skills/badge.svg)](/listings/larsw--report-writing-skills)

HTML

<a href="/listings/larsw--report-writing-skills"><img src="/api/listings/larsw--report-writing-skills/badge.svg" alt="findsafeskills safety rating" /></a>

Install

Install instructions from the README

As written by the repo's author. findsafeskills has not verified these steps.

The repository is at the same time an Agent Skills collection, an [Agent Plugins](https://agent-plugins.org) 1.0 plugin, a Claude Code plugin marketplace and a Gemini CLI extension, so most agents can install it directly from GitHub. Install all five skills together: they mention each other and the outline/drafting skills use the review skill's linter when it is present.

Any agent with Agent Skills support (40+ agents)

npx skills add larsw/report-writing-skills            # project scope; add -g for user scope
npx skills add larsw/report-writing-skills -a codex   # pick agents with -a (claude-code, codex, cursor, github-copilot, gemini-cli, opencode, windsurf, …)

The [`skills` CLI](https://github.com/vercel-labs/skills) detects installed agents and copies `skills/*` into each agent's skills directory.

Claude Code

/plugin marketplace add larsw/report-writing-skills
/plugin install report-writing@report-writing-skills

Codex, Cursor, GitHub Copilot, Kiro, VS Code (Agent Plugins)

The root [`plugin.json`](plugin.json) is an Agent Plugins 1.0 manifest with the skills in `skills/`.

npx plugins add larsw/report-writing-skills            # installs into the detected clients
copilot plugin install larsw/report-writing-skills     # GitHub Copilot CLI, directly from the repo

Or use the client's own plugin installer with the GitHub URL `https://github.com/larsw/report-writing-skills`.

Gemini CLI

gemini extensions install https://github.com/larsw/report-writing-skills

Claude.ai and Claude Desktop

Download the zip files from the [latest release](https://github.com/larsw/report-writing-skills/releases/latest) and upload each one under **Settings → Capabilities → Skills**. Each zip holds one skill folder; `report-writing-skills.zip` holds all five. Build them yourself with `python3 scripts/build_dist.py`.

Manual

Copy or symlink the folders in `skills/` into your agent's skills directory:

| Agent | Project scope | User scope | |---|---|---| | Claude Code | `.claude/skills/` | `~/.claude/skills/` | | Codex, Cursor, GitHub Copilot, Gemini CLI, OpenCode, Amp, Cline, Zed | `.agents/skills/` | Codex `~/.agents/skills/`, Cursor `~/.cursor/skills/`, Copilot `~/.copilot/skills/`, Gemini `~/.gemini/skills/`, OpenCode `~/.config/opencode/skills/` | | Windsurf | `.windsurf/skills/` | `~/.codeium/windsurf/skills/` | | Goose | `.goose/skills/` | `~/.config/goose/skills/` | | Kiro | `.kiro/skills/` | `~/.kiro/skills/` | | Roo Code | `.roo/skills/` | `~/.roo/skills/` |

git clone https://github.com/larsw/report-writing-skills.git
ln -s "$PWD"/report-writing-skills/skills/* ~/.claude/skills/

Agents without skill support

Clone the repository and add this to the agent's instruction file (`AGENTS.md`, rules file, custom instructions):

For planning, drafting, copyediting, reviewing or presenting technical reports, read and follow the
matching skill before starting: <path>/skills/report-outline/SKILL.md, report-drafting, report-copyedit,
report-review, report-presentation (same layout). Load files under a skill's references/ only when the
SKILL.md points to them.

What was scanned

The files the safety scan read, as written by the repository's author and shown as plain text. Lines with a finding are marked.

.claude-plugin/marketplace.json · Manifest · 15 lines
  1. {
  2. "name": "report-writing-skills",
  3. "owner": {
  4. "name": "Lars Wilhelmsen",
  5. "url": "https://github.com/larsw"
  6. },
  7. "plugins": [
  8. {
  9. "name": "report-writing",
  10. "source": "./",
  11. "description": "Plan, draft, copyedit, review and present technical reports",
  12. "version": "0.2.0"
  13. }
  14. ]
  15. }
README.md · README · 124 lines
  1. # report-writing-skills
  2. Five [Agent Skills](https://agentskills.io) for planning, drafting, copyediting, reviewing and presenting technical and scientific reports. They follow the method in Heike Hering's *How to Write Technical and Scientific Reports: Understandable Structure, Good Design, Convincing Presentation* (3rd ed., Springer 2025): the rules are paraphrased, adapted to current international practice, and turned into workflows, checklists and two small checking scripts.
  3. They work with plain prose, Markdown and extracted PDF text, and know **AsciiDoc/Asciidoctor**, **LaTeX** (siunitx, biblatex, cleveref, pgfplots), **asciidoctor-reveal.js**, **Beamer** and **PlantUML** in detail.
  4. | Skill | Use it to |
  5. |---|---|
  6. | [`report-outline`](skills/report-outline/SKILL.md) | analyze the task, find a title, build core message → 4-point → 10-point → detailed outline, pick a structure pattern (lab, design, project, thesis, IMRaD, decision report, manual), set up a style sheet and an AsciiDoc or LaTeX skeleton; check an outline's logic |
  7. | [`report-drafting`](skills/report-drafting/SKILL.md) | write sections (introduction, methods, results, summary, …), figures and PlantUML diagrams, tables and weighted evaluation matrices, formulas and computations, citations; never invents data, marks gaps instead |
  8. | [`report-copyedit`](skills/report-copyedit/SKILL.md) | light or medium line edit for clarity, one term per thing, notation and units, without changing content; leaves `###AQ` author queries |
  9. | [`report-review`](skills/report-review/SKILL.md) | pre-submission review: AsciiDoc/LaTeX linter + fictive-reader read + report checklist → "fix first" list and findings by severity |
  10. | [`report-presentation`](skills/report-presentation/SKILL.md) | turn a report into a talk and a reveal.js or Beamer deck, review slides, plan timing, rehearsal and Q&A, short statements |
  11. ## Install
  12. The repository is at the same time an Agent Skills collection, an [Agent Plugins](https://agent-plugins.org) 1.0 plugin, a Claude Code plugin marketplace and a Gemini CLI extension, so most agents can install it directly from GitHub. Install all five skills together: they mention each other and the outline/drafting skills use the review skill's linter when it is present.
  13. ### Any agent with Agent Skills support (40+ agents)
  14. ```sh
  15. npx skills add larsw/report-writing-skills # project scope; add -g for user scope
  16. npx skills add larsw/report-writing-skills -a codex # pick agents with -a (claude-code, codex, cursor, github-copilot, gemini-cli, opencode, windsurf, …)
  17. ```
  18. The [`skills` CLI](https://github.com/vercel-labs/skills) detects installed agents and copies `skills/*` into each agent's skills directory.
  19. ### Claude Code
  20. ```
  21. /plugin marketplace add larsw/report-writing-skills
  22. /plugin install report-writing@report-writing-skills
  23. ```
  24. ### Codex, Cursor, GitHub Copilot, Kiro, VS Code (Agent Plugins)
  25. The root [`plugin.json`](plugin.json) is an Agent Plugins 1.0 manifest with the skills in `skills/`.
  26. ```sh
  27. npx plugins add larsw/report-writing-skills # installs into the detected clients
  28. copilot plugin install larsw/report-writing-skills # GitHub Copilot CLI, directly from the repo
  29. ```
  30. Or use the client's own plugin installer with the GitHub URL `https://github.com/larsw/report-writing-skills`.
  31. ### Gemini CLI
  32. ```sh
  33. gemini extensions install https://github.com/larsw/report-writing-skills
  34. ```
  35. ### Claude.ai and Claude Desktop
  36. Download the zip files from the [latest release](https://github.com/larsw/report-writing-skills/releases/latest) and upload each one under **Settings → Capabilities → Skills**. Each zip holds one skill folder; `report-writing-skills.zip` holds all five. Build them yourself with `python3 scripts/build_dist.py`.
  37. ### Manual
  38. Copy or symlink the folders in `skills/` into your agent's skills directory:
  39. | Agent | Project scope | User scope |
  40. |---|---|---|
  41. | Claude Code | `.claude/skills/` | `~/.claude/skills/` |
  42. | Codex, Cursor, GitHub Copilot, Gemini CLI, OpenCode, Amp, Cline, Zed | `.agents/skills/` | Codex `~/.agents/skills/`, Cursor `~/.cursor/skills/`, Copilot `~/.copilot/skills/`, Gemini `~/.gemini/skills/`, OpenCode `~/.config/opencode/skills/` |
  43. | Windsurf | `.windsurf/skills/` | `~/.codeium/windsurf/skills/` |
  44. | Goose | `.goose/skills/` | `~/.config/goose/skills/` |
  45. | Kiro | `.kiro/skills/` | `~/.kiro/skills/` |
  46. | Roo Code | `.roo/skills/` | `~/.roo/skills/` |
  47. ```sh
  48. git clone https://github.com/larsw/report-writing-skills.git
  49. ln -s "$PWD"/report-writing-skills/skills/* ~/.claude/skills/
  50. ```
  51. ### Agents without skill support
  52. Clone the repository and add this to the agent's instruction file (`AGENTS.md`, rules file, custom instructions):
  53. ```markdown
  54. For planning, drafting, copyediting, reviewing or presenting technical reports, read and follow the
  55. matching skill before starting: <path>/skills/report-outline/SKILL.md, report-drafting, report-copyedit,
  56. report-review, report-presentation (same layout). Load files under a skill's references/ only when the
  57. SKILL.md points to them.
  58. ```
  59. ## Bundled scripts
  60. Both are stdlib-only Python 3 and follow `include::` and `\input`/`\include`.
  61. ```sh
  62. # AsciiDoc or LaTeX report: xrefs, citations vs .bib, captions and their position, labels/IDs,
  63. # \label before \caption, distorted images, lone subsections, heading form, intro sentences,
  64. # number–unit spacing, ranges, abbreviations, long sentences, open ### / TODO / \todo markers,
  65. # headings swallowed by missing blank lines (AsciiDoc)
  66. python3 skills/report-review/scripts/lint_report.py report.adoc [--json] [--known-abbrev FEM,CAD]
  67. python3 skills/report-review/scripts/lint_report.py main.tex
  68. # reveal.js (AsciiDoc) or Beamer deck: per-slide words, elements, notes, label headings,
  69. # thank-you slides, backup slides, speaking time from the speaker notes
  70. python3 skills/report-presentation/scripts/deck_stats.py deck.adoc --minutes 20
  71. python3 skills/report-presentation/scripts/deck_stats.py talk.tex --minutes 20
  72. ```
  73. ## Conventions
  74. The venue (university, company, customer, journal) always wins; the book's rules are the default where the venue is silent. Where the book conflicts with current international practice, the skills say so and default as follows:
  75. - Ranges with units: ISO 80000 / SI form ("160 °C to 200 °C" or "(160 to 200) °C").
  76. - Voice: the book's impersonal default for traditional engineering reports; active voice and "we" where the venue prefers it. The actor must always be clear.
  77. - Decimal point, true minus sign, en dash for ranges, 300 dpi for print, vector formats for diagrams.
  78. - German-specific items (DIN standards, declaration in lieu of an oath, decimal comma) are generalized.
  79. ## Development
  80. ```sh
  81. python3 scripts/check.py # frontmatter, vendored copies, manifest versions, script smoke tests
  82. python3 scripts/check.py --fix # re-copy vendored reference files
  83. python3 scripts/build_dist.py # dist/*.zip for archive-based installs
  84. ```
  85. Each skill has test cases under `skills/<skill>/evals/` in the `claude plugin eval` layout (`cd skills/<skill> && claude plugin eval . --allow-tools Write,Edit,Bash --scaffold`). Keep the versions in `plugin.json`, `.claude-plugin/plugin.json`, `.claude-plugin/marketplace.json` and `gemini-extension.json` equal.
  86. ## License
  87. [Apache License 2.0](LICENSE). See [NOTICE](NOTICE) for attribution. Not affiliated with or endorsed by the book's author or publisher.

Ratings and comments

Sign in to rate this skill.

Sign in

Free to use. If it’s helped, pass it on.