README.md

Ineuron's Projects Document Template

I know many developers are afraid of writing documentation of their projects. That's why I created this repository which helps you to create the project documentation in a easy way by just providing essential details about the project.

You can create all the FIVE documents with this i.e. Architecture, LLD, HLD, WireFrame and DPR.

How to create documents

• 🤡 Clone this repo

git clone https://github.com/arv-anshul/ineuron-project-docs-template

• ⭐ Go to ./docs/yaml/ directory and fill the YAML document's fields with your project description.

• 🤖 Run main.py.

python main.py

• 📁 Now, a new directory (export/markdowns/) created which contains the documents but in markdown format.

• ♻️ You can convert those markdowns with some md to pdf convertor app.

Remember: The md to pdf converter app must support mermaid graphs to render the graphs.

Documentation Demo

📝 Architecture Document

📝 LLD Document

📝 HLD Document

📝 WireFrame Document

📝 DPR Document

Raise Issue / Problem

If you have any query or problem you can raise here