arc42.org-site
www.yaml.org
Our great sponsors
arc42.org-site | www.yaml.org | |
---|---|---|
16 | 27 | |
6 | 317 | |
- | 2.2% | |
8.1 | 0.0 | |
about 1 month ago | 4 months ago | |
SCSS | HTML | |
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
www.yaml.org
-
Docker compose, orchestrating and automating services
First of all, create a file in the root project directories called compose.yaml. YAML is a text format that uses indentation to specify dependencies between configuration options. Be aware that incorrect indentation will cause problems with executing commands properly.
-
Kubernetes Through the Developer's Perspective
Most commonly written in YAML, these files are large and complex to read and understand. And being written in YAML comes with its challenges (and quirks) since it is an additional programming language that devs need to learn.
- Yaml.org Has Gone Away
- YAML's homepage is displayed in YAML
-
whatDoesTheGStandFor
YAML Ain't a Markup Language
-
A View on Functional Software Architecture
Note, that this file is a Markdown and YAML file at the same time, and as such human- and machine-readable, if the fields are filled carefully.
-
Exploring the code behind Docusaurus
Front matter is a bit of text at the start of a file (YAML to be exact) that is placed between two ---
-
topoconfig: enhancing config declarations with graphs
Meanwhile, formats have been evolving (JSON5, YAML), config entry points are constantly changing. These fluctuations, fortunately, were covered by tools like the cosmiconfig.
- That's a Lot of YAML
-
Official Stormgate Gameplay Reveal AMA Thread with Frost Giant Studios
Personally, I'd love to see them using a standard file format like TOML or YAML so that they're easy to parse and work with using already-existing tools.
What are some alternatives?
diataxis-documentation-framework - A systematic approach to creating better documentation.
yj - CLI - Convert between YAML, TOML, JSON, and HCL. Preserves map order.
jgmd - A directory of direct links to get your personal data from web services.
helm-charts - Helm charts for New Relic applications
c4-notation - Technical resources for using the C4 model for visualizing software architecture.
json2jsii - Generates jsii-compatible structs from JSON schemas
architecture_decision_record - Architecture decision record (ADR) examples for software planning, IT leadership, and template documentation
config - Helps you find, load, combine, autofill and validate configuration values of any kind
architecture-decision
honeysql - Turn Clojure data structures into SQL
java - Structurizr for Java
uniconfig - Yet another one config processor. Weird. Slow. Our own.