| name | generating-writeup |
| description | Academic/technical writeups with Pandoc-compatible markdown. Use for documentation, reports, or technical explanations. |
| compatibility | Designed for Claude Code |
| metadata | {"allowed-tools":"Read, Write, Edit, Bash, Glob, Grep"} |
Technical Writeup Generation
Creates structured technical documentation in Pandoc-compatible markdown.
Suitable for academic papers, technical reports, and documentation.
Workflow
- Define scope - Audience, purpose, length constraints
- Outline structure - Logical section progression
- Write content - Clear, precise technical language
- Add formatting - Pandoc-compatible markdown
- Add citations - BibTeX references, see
template.md for syntax
- Review and refine - Clarity, accuracy, completeness
Document Structure
---
title: "Document Title"
author: "Author Name"
date: YYYY-MM-DD
bibliography: references.bib
reference-section-title: References
abstract: |
Brief summary of document contents and key findings.
---
See template.md in this skill directory for full template with
frontmatter, BibTeX examples, and directory structure.
Citation Styles
| Style | Format | Example |
|---|
| IEEE | numeric | [1] |
| APA | author-date | (Author, 2024) |
| Chicago | author-date | (Author 2024) |
| Vancouver | numeric | (1) |
Alternatives available from the Zotero Style Repository.
Formatting Standards
Code Blocks:
def example():
return "formatted code"
Tables:
Citations:
Use [@citation-key] for Pandoc citations.
Math:
Inline: $E = mc^2$
Block: $$\int_0^\infty f(x) dx$$
Pandoc Integration
pandoc 0*.md -o output.pdf --citeproc --number-sections
CRITICAL: NEVER add manual section numbers to headings.
Use --number-sections flag in pandoc. Manual "2. Section" creates
duplicate numbering in PDFs.
Output Formats
Academic: Full structure with abstract, citations, formal language
Technical: Focused on implementation, code examples, diagrams
Report: Executive summary, findings, recommendations
Quality Checks