arc42.org-site
Diagon
Our great sponsors
arc42.org-site | Diagon | |
---|---|---|
16 | 7 | |
6 | 1,428 | |
- | - | |
8.1 | 5.1 | |
about 1 month ago | about 1 month ago | |
SCSS | C++ | |
MIT License | MIT License |
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.
arc42.org-site
-
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:
-
Architecture diagrams enable better conversations
I've been using https://structurizr.com/ to automatically generate C4 diagrams from a model (rather than drawing them by hand). It works well with the approach for written documentation as proposed in https://arc42.org/. It's very easy to embed a C4 diagram into a markdown document.
The result is a set of documents and diagrams under version control that can be rendered using the structurizr documentation server (for interactive diagrams and indexed search).
I also use https://d2lang.com/ for declarative diagrams in addition to C4, e.g., sequence diagrams and https://adr.github.io/ for architectural decision records. These are also well integrated into structurizr.
-
Documenting a software project
My general approach to documentation is a "software guidebook" (free e-book link) or arc42 ... complemented with diagrams and architecture decision records where necessary.
-
System Design How to?
In addition to a small number of diagrams, I'd recommend something like arc42 or my "software guidebook" (link for a free copy of my book describing this), plus some architecture decision records.
-
Solution Templates
Arc42 may give some inspiration https://arc42.org/
-
What's your process to create documentation for a new startup's application?
If you need more structure than ADRs then https://arc42.org is super useful.
-
Recommendations for an Online Introduction to Software Modeling
There are plenty of good resources out there for learning modeling languages and architectural documentation structures. For more lightweight methods, I'd recommend checking out resources like Simon Brown's C4 model for visualizing software architecture, Martin Fowler's UML Distilled: A Brief Guide to the Standard Object Modeling Language, Scott Ambler's Agile Modeling site, and the arc42 template for architectural documentation.
-
How to get good at writing design documents?
As you need to, you can get into topics like different modeling languages or documentation template libraries. These are going to be highly dependent on your organization, though, as different organizations have different standards for what and how to document design decisions. Personally, I've found that the arc42 documentation template plus the C4 modeling language plus the UML modeling language (see UML as sketch and UML as notes for more on lightweight UML) for the most detailed models (which are rarely needed outside of the most complex parts of a system) tends to be a good, agile, lightweight model for the kinds of things to think about when it comes to creating design documentation.
-
How to improve writing documentation?
We've started using Arc42 and C4 model & PlantUML for diagrams. Working out well so far.
-
About documentation
arc42 - arc42
Diagon
-
Architecture diagrams enable better conversations
A few more ASCII-based tool that you could add into your workflow are https://arthursonzogni.com/Diagon/#Sequence which can be used to generate the ASCII that you input into something like Typogram (https://google.github.io/typograms/).
For example, input:
Renderer -> Browser: BeginNavigation()
- Typograms: A definition and renderer for ASCII diagrams
-
Hacker News top posts: Dec 21, 2021
Diagon – Interactive ASCII art diagram generators\ (4 comments)
- Diagon – Interactive ASCII art diagram generators
-
Plugin to draw diagrams in Vim
Diagram types supported could be found in upstream repo.
-
Plugin to draw diagrams in Vim using Diagon API
Basically this is a wrapper of Diagon's command line interface to help you draw Unicode or ASCII diagrams in Vim. Please have a look.
-
Vim for presentation?
Doing presentations directly in vim is kinda insane, but if you are insane, I have the tool for you here.
What are some alternatives?
diataxis-documentation-framework - A systematic approach to creating better documentation.
vnote - A pleasant note-taking platform.
jgmd - A directory of direct links to get your personal data from web services.
vim-diagon - Vim wrapper of Diagon API to generate simple Unicode or ASCII diagrams
c4-notation - Technical resources for using the C4 model for visualizing software architecture.
sent - a simple plaintext presentation tool
architecture_decision_record - Architecture decision record (ADR) examples for software planning, IT leadership, and template documentation
litee.nvim - A framework for building Neovim plugins
architecture-decision
KAI - KAI is a distributed computing model written in modern C++ and is cross-plaftorm. Using custom language translators and an executor, KAI provides full reflection, persistence and cross-process communications without having to modify existing source code. KAI Comes with an automated, generational tricolor garbage collector, and Console- and Window-based interfaces.
java - Structurizr for Java
vroom-pm - Vim Based Slideshow Presentations