# ๐ Paper Writer
### AI-Powered Academic Paper Writing Agent for Claude Code
[](LICENSE)
[](https://claude.ai)
[]()
**[ไธญๆๆๆกฃ](README.zh-CN.md)** ยท [Report Bug](https://github.com/WuSuBuDuoMing/paper-writer/issues) ยท [Request Feature](https://github.com/WuSuBuDuoMing/paper-writer/issues)
---
## ๐ Overview
Paper Writer is a **Claude Code agent system** for academic paper writing. It provides specialized AI agents, prompt templates, and formatting guides to help researchers write high-quality academic papers from outline to final draft.
### What's Included
- ๐ค **6 Specialized Agents** โ Paper Writer, Literature Reviewer, Methodology Designer, Data Analyst, Academic Editor, Citation Manager
- ๐ **5 Section Prompts** โ Abstract, Introduction, Methodology, Results, Discussion
- ๐ **3 Formatting Styles** โ APA 7th, IEEE, GB/T 7714-2015
- ๐ **2 Language Guides** โ Chinese Academic Writing, English Academic Writing
- ๐ **Multi-language** โ Full support for Chinese and English papers
---
## ๐ Quick Start
### Prerequisites
- [Claude Code](https://claude.ai/code) installed
- Claude subscription (Pro, Team, or Enterprise)
### Installation
```bash
# 1. Clone the repository
git clone https://github.com/WuSuBuDuoMing/paper-writer.git
cd paper-writer
# 2. Copy agent definitions to your project
cp -r .claude/ /path/to/your/paper-project/.claude/
# 3. Start writing!
claude
```
### Usage
#### In Claude Code CLI
```bash
# Start Claude Code in your paper project directory
claude
# Then use slash commands:
/outline "ๆทฑๅบฆๅญฆไน ๅจๅปๅญฆๅฝฑๅ่ฏๆญไธญ็ๅบ็จ"
/literature "transformer medical imaging"
/method "ๅฎ้็ ็ฉถ ้ฎๅท่ฐๆฅ"
/write abstract
/polish "่ฟๆฎตๆๆฌ"
/review
```
#### As Agent Definitions
Copy the `.claude/agents/` files to your project's `.claude/agents/` directory. Claude Code will automatically recognize them.
---
## ๐ค Agents
### Paper Writer (Main Agent)
The orchestrator agent that manages the entire paper writing workflow. Handles topic selection, outline generation, section-by-section writing, and quality review.
### Literature Reviewer
Specializes in systematic literature search, analysis, and synthesis. Helps organize literature by themes, methods, or chronology.
### Methodology Designer
Helps design research methodology including study design, sampling strategy, data collection instruments, and validity/reliability analysis.
### Data Analyst
Assists with statistical analysis interpretation, result description, table/figure formatting, and writing the results section.
### Academic Editor
Polishes academic language, checks formatting, fixes grammar, converts between Chinese and English academic writing styles.
### Citation Manager
Manages references, generates citations in APA/IEEE/GB-T 7714 format, checks citation consistency, and generates BibTeX entries.
---
## ๐ Prompt Templates
Each template provides a structured prompt for generating specific paper sections:
| Template | Description |
|----------|-------------|
| [Abstract](prompts/sections/abstract.md) | Generate structured Chinese/English abstracts |
| [Introduction](prompts/sections/introduction.md) | Write introduction with background, problem, significance |
| [Methodology](prompts/sections/methodology.md) | Design research methodology with full detail |
| [Results](prompts/sections/results.md) | Write results with statistical reporting |
| [Discussion](prompts/sections/discussion.md) | Write discussion with theoretical and practical implications |
---
## ๐ Formatting Styles
| Style | File | Use Case |
|-------|------|----------|
| APA 7th Edition | [apa7.md](prompts/styles/apa7.md) | Psychology, Education, Social Sciences |
| IEEE | [ieee.md](prompts/styles/ieee.md) | Engineering, Computer Science, Electronics |
| GB/T 7714-2015 | [gb-t7714.md](prompts/styles/gb-t7714.md) | Chinese academic papers (national standard) |
---
## ๐ Language Guides
| Guide | Description |
|-------|-------------|
| [Chinese Academic Writing](prompts/languages/chinese-academic.md) | ๅญฆๆฏ็จ่ฏญ่ง่ใๅธธ่ง้ฎ้ขไฟฎๆญฃใๆฎต่ฝ็ปๆ |
| [English Academic Writing](prompts/languages/english-academic.md) | Hedging language, tense usage, common patterns |
---
## ๐ Project Structure
```
paper-writer/
โโโ .claude/
โ โโโ agents/ # Claude Code agent definitions
โ โ โโโ paper-writer.md # Main orchestrator agent
โ โ โโโ literature-reviewer.md # Literature review specialist
โ โ โโโ methodology-designer.md# Research methodology expert
โ โ โโโ data-analyst.md # Data analysis & results
โ โ โโโ academic-editor.md # Language polish & formatting
โ โ โโโ citation-manager.md # Reference management
โ โโโ commands/ # (Reserved for slash commands)
โ
โโโ prompts/
โ โโโ sections/ # Section-specific prompt templates
โ โ โโโ abstract.md
โ โ โโโ introduction.md
โ โ โโโ methodology.md
โ โ โโโ results.md
โ โ โโโ discussion.md
โ โโโ styles/ # Formatting style guides
โ โ โโโ apa7.md
โ โ โโโ ieee.md
โ โ โโโ gb-t7714.md
โ โโโ languages/ # Language writing guides
โ โโโ chinese-academic.md
โ โโโ english-academic.md
โ
โโโ examples/ # (Coming soon)
โโโ README.md
โโโ README.zh-CN.md
โโโ LICENSE
โโโ CONTRIBUTING.md
โโโ CHANGELOG.md
```
---
## ๐ฏ Supported Paper Types
- **Journal Articles** โ Original research papers
- **Conference Papers** โ Short-form conference submissions
- **Thesis/Dissertation** โ Master's and PhD theses
- **Review Papers** โ Systematic and narrative reviews
- **Research Proposals** โ Grant applications and study proposals
- **Literature Reviews** โ Standalone review chapters
---
## ๐ค Contributing
Contributions are welcome! See [CONTRIBUTING.md](CONTRIBUTING.md) for guidelines.
1. Fork the repository
2. Create your feature branch (`git checkout -b feature/amazing-feature`)
3. Commit your changes (`git commit -m 'feat: add amazing feature'`)
4. Push to the branch (`git push origin feature/amazing-feature`)
5. Open a Pull Request
---
## ๐ License
This project is licensed under the **MIT License** โ see the [LICENSE](LICENSE) file for details.
---
**Made with โค๏ธ for better academic writing**
[โฌ Back to top](#-paper-writer)