foundation for professional research projects with automated workflows
Quick Reference: How To Use | Examples | Architecture
This template provides a foundation for research projects with:
src/- Core business logic with test coveragetests/- test suite ensuring code qualityscripts/- Thin orchestrators that use tested methodsmanuscript/- Research manuscript sections (generates PDFs)output/- Generated PDFs, figures, and data
- test coverage for all source code
- Automated testing before any build process
- Quality assurance built into the workflow
- Markdown-to-multiformat pipeline: PDF + HTML + Slides ship by default; DOCX and EPUB are opt-in via
render.formatsinmanuscript/config.yaml. Pandoc + xelatex drive the pipeline; see output-formats.md for the full matrix. - Cross-referencing system for complex documents
- Automated figure generation from Python scripts
- Glossary generation from source code
- Thin orchestrator pattern for maintainable code
- Clear separation of concerns between logic and orchestration
- Reusable components that work across projects
- Professional standards for academic and commercial use
- Academic research papers
- Scientific documentation
- Technical reports
- Thesis and dissertation projects
- Research proposals
- Software documentation
- Any project requiring professional output
- Python 3.10+ for core functionality
- Pandoc + LaTeX for PDF generation
- Pytest for testing
- Markdown for content authoring
- Git for version control
../core/how-to-use.md- usage guide from basic to advanced../core/architecture.md- System design overview../core/workflow.md- Development workflow guidemarkdown-template-guide.md- Writing and formatting guideexamples.md- Usage examples and customizationthin-orchestrator-summary.md- Pattern implementation detailsREADME.md- project overviewexamples-showcase.md- Real-world usage examples
- Use this template to create your new repository
- Customize the project name and configuration
- Add your content to the manuscript files
- Implement your logic in the src/ directory
- Run the build pipeline to generate professional output
| Issue | Solution |
|---|---|
| Project not in menu | Create manuscript/config.yaml |
| Test import errors | Ensure tests/conftest.py exists |
| Stage 4 fails fast | Add project deps to root pyproject.toml |
| Config warnings | Use project_config: prefix for custom keys |
Full troubleshooting: Common Errors | FAQ
Transform your research workflow with this professional template! 🚀
For detailed setup and usage instructions, see ../core/how-to-use.md for guidance, README.md for overview, and ../core/workflow.md for development process.