Best-README-Template VS C4-PlantUML

othneildrew/Best-README-Template is the basis for this creation.

I use this template to help get a jumpstart.

Best-README-Template

A README.md template: https://github.com/othneildrew/Best-README-Template

Every repository should contain a Readme file with (at least) a project description and instructions on how to set up the project, run it, run the tests, and which technologies are used. Here is the link to the template example.

I use a RDD approach - README Driven Development. (I think some would call this Documentation Driven Development [https://gist.github.com/zsup/9434452], but its way more simplified, in order to get started quicker.) I like to use a good template so I can track my progress. As more features are added, the template gets more filled in. And tbh, i get a bit more driven when i see more and more of the template filled in with screenshots, logos, guides, etc. A good template for me is https://github.com/othneildrew/Best-README-Template.

See the open issues for a full list of proposed features (and known issues).

othneildrew has a robust readme template, and DomPizzie has a simple one.

Here’s a great template to get started!

[contributors-url]: https://github.com/othneildrew/Best-README-Template/graphs/contributors

C4-PlantUML: Export your model as C4-PlantUML diagrams.

PlantUML + C4 plugin;

Yes. I use this all the time for software diagramming. With c4 model (https://github.com/plantuml-stdlib/C4-PlantUML) and AWS icons (https://github.com/awslabs/aws-icons-for-plantuml)

The C4 model (https://c4model.com/) is great for architecture diagrams. You can use different tools to generate them. Here are the ones I've been using:

- https://github.com/plantuml-stdlib/C4-PlantUML

3️⃣ Text-based diagramming- C4-PlantUML

> onboarding docs

yes, they're don't changing frequently

> system design docs

yes - see C4-PlantUML[1]

> meeting notes

no, unless they're directly code related like ADRs [2,3].

Although one can abuse Github Issues + comments for this, in my opinion it's better to use modern SaaS tools for this, i.e. Loom, Descript, Linear.app, etc. - you can automate this process, e.g. transcribe the meeting's recording and add the issue/repo using Github Actions.

--

[1] https://github.com/plantuml-stdlib/C4-PlantUML

[2] https://adr.github.io/

[3] https://docs.aws.amazon.com/prescriptive-guidance/latest/arc...

I use a combination of: * Markdown (for notes and code blocks) * Mermaid markdown (for architectural diagrams in markdown documents) * PlantUML markdown (again for arch. docs in markdown, but mainly for C4 diagrams) * a Docker container to render PlantUML markdown to images * Joplin, installed on every device I regularly use * NextCloud, to store, secure, encrypt, and make available everywhere, the markdown notes managed by Joplin