Best-README-Template
c4-notation
Best-README-Template | c4-notation | |
---|---|---|
21 | 126 | |
13,088 | 25 | |
- | - | |
2.7 | 10.0 | |
about 1 month ago | almost 5 years ago | |
MIT License | Apache License 2.0 |
Stars - the number of stars that a project has on GitHub. Growth - month over month growth in stars.
Activity is a relative number indicating how actively a project is being developed. Recent commits have higher weight than older ones.
For example, an activity of 9.0 indicates that a project is amongst the top 10% of the most actively developed projects that we are tracking.
Best-README-Template
-
wf.nvim: a new which-key plugin for Neovim.
othneildrew/Best-README-Template is the basis for this creation.
-
Is that how C++ Github portfolio should look for junior position?
I use this template to help get a jumpstart.
-
Bokeverse - The decentralised 2D Open World RPG
Best-README-Template
-
NEED ADVISE! User Documentation for a software add-on
A README.md template: https://github.com/othneildrew/Best-README-Template
-
Markdown overview
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.
-
How much do i really need to plan out my applications before i start developing?
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.
-
Hacktobefest 2022: My Repo
See the open issues for a full list of proposed features (and known issues).
-
Does anyone also know of a good template that follows some sort of technical writing principles on a Github README file?
othneildrew has a robust readme template, and DomPizzie has a simple one.
-
Your Resume Is Not Important
Here’s a great template to get started!
-
stinky monkey
[contributors-url]: https://github.com/othneildrew/Best-README-Template/graphs/contributors
c4-notation
-
Ask HN: Guidelines for making clear architecture diagrams
Second this.
Reference for anyone looking I to it: https://c4model.com/
There is also quite a lot of options for helping create these diagrams. I've found https://structurizr.com/ to be the best of what I've tried so far.
-
Show HN: Flyde – an open-source visual programming language
What you are describing sounds a lot like C4: https://c4model.com/
-
Ask HN: How do you document complex software systems?
The C4 model [0] provides a mostly sensible structure and techniques for representing pure software systems across different abstraction levels.
For systems involving software and hardware, or other complex interfacing (both technology and bureaucracy) this starts to delve into the universe of systems engineering. There's a decent assembly of knowledge on that in the SEBoK [1].
As another commenter has already called out too, one of the most valuable sources of information is also _why_ a system is in its current form and _how_ that's changed over time. ADR's [2] really do a good job at nailing this for just about any scale.
[0]: https://c4model.com
[1]: https://sebokwiki.org
[2]: https://adr.github.io
-
A View on Functional Software Architecture
There a various standards for documenting software architecture, like arc42 or C4. While useful and somewhat well-known (there is certainly a correlation here), here architecture documentation can be further simplified, particularly due to the self-similarity of project and component. Following is a small template, that can also serve as a project's and component's README:
- The C4 model for visualising software architecture
-
Inkscape Cloud Architect
I would suggest that if your architecture diagrams are a bunch of icons provided by AWS/Azure/GCP with lines pointing at each other... you are doing it wrong.
The 'what does this box do for my system' is vastly more important than the 'which in vogue offering from my cloud provider implements it'.
I highly suggest folks take a look at the C4 Model: https://c4model.com/
- What do you wish business folks knew about UML?
-
How to create interactive zoomable software architecture diagrams
We often use abstractions in software engineering to communicate complex architectures and software systems. In this article, we’ll discuss how abstractions are inherently hierarchical and how the C4 model provides a nested structure for defining your software architecture. We’ll then cover how IcePanel allows you to create interactive and zoomable diagrams for your audience to zoom in and out of different levels of technical detail.
-
Architecture diagrams enable better conversations
You probably want https://c4model.com/ which explains what a C4 architecture diagram is. (See the first footnote in the article.)
What are some alternatives?
readme.so - An online drag-and-drop editor to easily build READMEs
excalidraw - Virtual whiteboard for sketching hand-drawn like diagrams
C4-PlantUML - C4-PlantUML combines the benefits of PlantUML and the C4 model for providing a simple way of describing and communicate software architectures
backstage - Backstage is an open platform for building developer portals
nodetskeleton - A NodeJs Skeleton based in Clean Architecture to use TypeScript with ExpressJS, KoaJS or any other web server framework. Please give star to project to show respect to author and effort. 🤗
awesome-readme-template - An awesome README template for your projects!
mermaid - Generation of diagrams like flowcharts or sequence diagrams from text in a similar manner as markdown
readme-template - A Readme Template For Tomorrow's Opensource
pumla - pumla - systematic re-use of model elements described with PlantUML
art-of-readme - :love_letter: Things I've learned about writing good READMEs.
plantuml - Generate diagrams from textual description