Essential documentation for all users
Quick Reference: How To Use | Architecture | Workflow | Documentation Index
The core/ directory contains the essential documentation that all users should read to understand and use the Research Project Template effectively.
| File | Purpose | Audience |
|---|---|---|
how-to-use.md |
usage guide from basic to advanced (all 12 levels) | New users, developers |
architecture.md |
System design and structure overview | Developers, architects |
workflow.md |
Development workflow and best practices | Developers |
literature-data-flow.md |
Literature-search data pipeline and reference flow | Developers, researchers |
- Start with
how-to-use.md- usage guide - Review
architecture.md- Understand system design - Follow
workflow.md- Learn development process
- Read
architecture.md- System design overview - Study
workflow.md- Development process - Reference
how-to-use.md- Usage patterns
../guides/- Skill-level specific usage guides../architecture/- Detailed architecture documentation../usage/- Usage examples and patterns../reference/- Quick reference materials
../documentation-index.md- documentation index../README.md- Documentation hub overview../AGENTS.md- Documentation organization guide