efficience_it / diataxis-guide
Template to build documentation on a symfony project
README
Welcome to the documentation structure for Symfony projects, based on the Diátaxis framework.
This framework organizes documentation into four complementary sections:
- Tutorials — learning-oriented step-by-step guides
- How-to Guides — task-based, problem-solving instructions
- Reference — technical, exhaustive information
- Explanations — discussions, background, and reasoning
⚡️ Quick Start
To scaffold a documentation structure in your Symfony project, just run:
composer require efficience_it/diataxis-guide
This will automatically create a .docs/ folder at the root of your project, with the following layout:
.docs/
├── index.md
├── tutorials/
│ ├── 01_installation.md
│ └── README.md
├── how-to-guides/
│ └── README.md
├── reference/
│ └── README.md
└── explanations/
└── README.md
You’re now ready to start writing structured documentation for your Symfony codebase!
📚 Table of Contents (in .docs/)
- Tutorials: Learn from scratch with detailed steps.
- How-to Guides: Solve specific problems.
- Reference: Technical and detailed configuration.
- Explanations: Understand the concepts behind the code.
🛠 About This Package
This Composer package installs a pre-built documentation skeleton tailored for Symfony projects.
It’s ideal for teams who want to adopt good documentation practices without reinventing the wheel.
💡 Inspiration
This project is based on the Diátaxis documentation system,
a simple but powerful way to write developer documentation that actually helps users.
Happy documenting! ✍️