arc42.org-site
asciiflow
Our great sponsors
arc42.org-site | asciiflow | |
---|---|---|
16 | 51 | |
6 | 4,400 | |
- | - | |
8.1 | 6.4 | |
about 1 month ago | 24 days ago | |
SCSS | TypeScript | |
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
asciiflow
- How the Devteam Conquered the iPhone
- Monodraw
-
Nomnoml
> 7. You can put them in the source where they are relevant.
> Got a hairy state machine? Stick a comment at the top with something like nomnoml's syntax and anyone can follow what's going on without having to trace through the code.
For that use-case a markup graph language is a poor solution. Use https://asciiflow.com instead to produce something that people can digest without needing a third-party tool that may not even exist anymore.
- Architecture diagrams enable better conversations
-
Typograms: A definition and renderer for ASCII diagrams
Many diagrams I am able to draw manually as I'm editing source code on emacs, but for more complicated ones I tend to use this: https://asciiflow.com . To each their own, so pick your favorite ASCII editor.
-
Good graphic FlowChart drawing tool ?
This isn't at all what you are asking for but I use it in code all the time for flow-charting logic. https://asciiflow.com/ And on the plus side, the output is very portable.
-
[CppSerbia Meetup] C++ Customisation Points
Combination of: - http://maaslalani.com/slides/ - for slides - figlet/toilet/cowsay/lolcat - for generating titles and ascii art - https://github.com/lewish/asciiflow - for charts and diagrams
-
Oracle Industries: Helion Gasworks - My survival H2 facility!
So I used this website: https://asciiflow.com to draw out the diagrams and then pasted them into the LCDs using the monospace font! An LCD is 39x58 "ASCII tiles" FYI if you wanted to do this too!
-
What are considerations to make a website secure?
AsciiFlow
- Top 8 diagramming tools for software architecture
What are some alternatives?
diataxis-documentation-framework - A systematic approach to creating better documentation.
excalidraw - Virtual whiteboard for sketching hand-drawn like diagrams
jgmd - A directory of direct links to get your personal data from web services.
GeneWeb - GeneWeb is a free (as in free speech) genealogy software with a web interface created by Daniel de Rauglaudre.
c4-notation - Technical resources for using the C4 model for visualizing software architecture.
Mermaid - Edit, preview and share mermaid charts/diagrams. New implementation of the live editor.
architecture_decision_record - Architecture decision record (ADR) examples for software planning, IT leadership, and template documentation
blynk - Blynk is an Internet of Things Platform aimed to simplify building mobile and web applications for the Internet of Things. Easily connect 400+ hardware models like Arduino, ESP8266, ESP32, Raspberry Pi and similar MCUs and drag-n-drop IOT mobile apps for iOS and Android in 5 minutes
architecture-decision
Reactive Resume - A one-of-a-kind resume builder that keeps your privacy in mind. Completely secure, customizable, portable, open-source and free forever. Try it out today! [Moved to: https://github.com/AmruthPillai/Reactive-Resume]
java - Structurizr for Java
Monica - Personal CRM. Remember everything about your friends, family and business relationships.