qte77/plugins/docs-generator/skills/generating-writeup
plugins/docs-generator/skills/generating-writeup/SKILL.md
--- name: generating-writeup description: Generates academic/technical writeups with IEEE citations and pandoc PDF output. Use when creating research papers, technical reports, or documentation with references. compatibility: Designed for Claude Code metadata: allowed-tools: Read, Write, Edit, Bash, Glob, Grep, WebSearch, WebFetch argument-hint: [topic] [template] [citation-style] stability: stable content-hash: sha256:9e500bc5e5b4c840c55fdb360e80ad198953af3b1be65784df0f00ae22cbf5ad la
$ install --global
skillsauthnpx skillsauth add qte77/claude-code-utils-plugin plugins/docs-generator/skills/generating-writeupInstall this skill globally with one command. Works with Claude Code, Cursor, and Windsurf.
Security Scan Results
3 of 9 scanners reported clean
Some scanners were skipped, did not run, or reported a non-clean status. Review each row below.
3
Scanners Passed
9
Scanners in report
Clean
TrivyContainer and dependency vulnerability scanner
95%
Clean
SemgrepStatic code analysis for vulnerabilities
95%
Clean
mcp-scan (Snyk)Model Context Protocol security validation
95%
Skipped
Snyk (dep)Open source security scanning
50%
Skipped
Socket.devSupply chain security analysis
50%
Skipped
VirusTotalMulti-engine malware detection
50%
Skipped
CrowdStrikeAdvanced threat intelligence
50%
Skipped
OSV-ScannerOpen Source Vulnerability database check
50%
Skipped
OWASP Dep-Check
50%
Last scanned: Apr 17, 2026, 11:29 AM4.7s21 files scanned
SKILL.md
- name:
- generating-writeup
- description:
- Generates academic/technical writeups with IEEE citations and pandoc PDF output. Use when creating research papers, technical reports, or documentation with references.
- compatibility:
- Designed for Claude Code
- allowed-tools:
- Read, Write, Edit, Bash, Glob, Grep, WebSearch, WebFetch
- argument-hint:
- [topic] [template] [citation-style]
- stability:
- stable
- content-hash:
- sha256:9e500bc5e5b4c840c55fdb360e80ad198953af3b1be65784df0f00ae22cbf5ad
- last-verified-cc-version:
- 1.0.34
Writeup Generation
Target: $ARGUMENTS
Generates structured academic/technical writeups as markdown with citation
support. IEEE [1] style by default. PDF export via pandoc is optional.
Workflow
- Parse arguments - Extract topic, template (default:
project-report-IMRaD), and citation style - Create directory -
docs/write-up/<topic>/ - Copy template - Copy from
templates/todocs/write-up/<topic>/:project-report-IMRaD— scientific/academic (Introduction, Methods, Results, Discussion)technical-doc— software documentation (Overview, Architecture, API, Config, Deployment)
- Fill sections - Replace TODO comments in each chapter file
- Setup bibliography - Add entries to
09a_bibliography.bib - Run markdownlint -
npx markdownlint-cli docs/write-up/<topic>/*.md - Generate PDF (optional) - If pandoc is available, run
make pandoc_run
Additional Resources
- Templates: project-report-IMRaD/ | technical-doc/
- Setup help:
make -f $CLAUDE_PLUGIN_ROOT/Makefile setup_pdf_converter HELP - Pandoc help:
make -f $CLAUDE_PLUGIN_ROOT/Makefile pandoc_run HELP=1
Citation Styles
| Style | CSL File | Notes |
| ----- | -------- | ----- |
| IEEE (default) | Bundled (scripts/writeup/citation-styles/ieee.csl) | Numeric [1] |
| APA | Bundled (scripts/writeup/citation-styles/apa.csl) | Author-date (Smith, 2024) |
| Chicago | Bundled (scripts/writeup/citation-styles/chicago-author-date.csl) | Author-date (Smith 2024) |
Additional CSL files are available from the Zotero Style Repository.
PDF Export (Optional)
If pandoc and LaTeX are installed, generate PDF using the bundled Makefile:
dir=docs/write-up/<topic> && \
make -f $CLAUDE_PLUGIN_ROOT/Makefile pandoc_run \
INPUT_FILES="$$(printf '%s\036' $$dir/*.md)" \
OUTPUT_FILE="$$dir/output.pdf" \
BIBLIOGRAPHY="$$dir/09a_bibliography.bib"
With custom citation style:
dir=docs/write-up/<topic> && \
make -f $CLAUDE_PLUGIN_ROOT/Makefile pandoc_run \
INPUT_FILES="$$(printf '%s\036' $$dir/*.md)" \
OUTPUT_FILE="$$dir/output.pdf" \
BIBLIOGRAPHY="$$dir/09a_bibliography.bib" \
CSL="$CLAUDE_PLUGIN_ROOT/scripts/writeup/citation-styles/apa.csl"
Full writeup build (content generation + PDF):
make -f $CLAUDE_PLUGIN_ROOT/Makefile writeup \
WRITEUP_DIR=docs/write-up/<topic>
Section Numbering (MANDATORY)
NEVER add manual section numbers to headings. Pandoc --number-sections
handles all numbering automatically.
- Wrong:
# 2. Projektvorstellung,## 2.1 Motivation,### 2.1.1 Details - Correct:
# Projektvorstellung,## Motivation,### Details
Manual numbers in markdown headings conflict with pandoc auto-numbering and produce duplicated numbers in the PDF output.
Quality Checks
Before completing:
- No manual section numbers - Headings must not contain
N.,N.N,N.N.Nprefixes - Markdownlint -
npx markdownlint-cli docs/write-up/<topic>/*.md - Citation validation - Verify all
[@key]references exist in.bibfile - PDF generation (optional) - If pandoc available, run
make pandoc_run
Further Reading
- Pandoc User's Guide
- Zotero Style Repository
- Citation Style Language Specification
- BibTeX Entry Types
Related Skills
qte77/researching-website-design
development
VerifiedTrustedCommunity
Analyzes industry websites for design patterns, layout, typography, and content strategies using first-principles thinking. Use when researching website design, UI patterns, or competitive design analysis.
1SKILL.mdUpdated Apr 19, 2026
qte77/auditing-website-usability
development
VerifiedTrustedCommunity
Audits website usability for UX optimization, covering forms, navigation, validation, and microcopy. Use when reviewing user experience, task completion flows, or interface friction points.
1SKILL.mdUpdated Apr 19, 2026
qte77/auditing-website-accessibility
development
VerifiedTrustedCommunity
Audits website accessibility for WCAG 2.1 AA compliance, generating findings and code fixes. Use when reviewing accessibility, keyboard navigation, screen reader compatibility, or inclusive design.
1SKILL.mdUpdated Apr 19, 2026
qte77/testing-typescript
development
VerifiedTrustedCommunity
Writes tests following TDD (using vitest and @testing-library/react) best practices. Use when writing unit tests, integration tests, or component tests in TypeScript.
1SKILL.mdUpdated Apr 19, 2026