article thumbnail

C4 PlantUML: Effortless Software Documentation

Apiumhub

Introduction Documentation plays a crucial role in any project, serving as a compass for development teams, and as a good way for the new joiners to know how the project is done. Within the context diagrams, emphasis is placed on elucidating the roles and interactions among different systems. Detail component implementation specifics.

article thumbnail

Diagramming System Architecture in 5 Simple Steps

Tandem

As part of our final project handoff to Tandem clients, we provide a diagram of the product’s architecture — a visual depiction of the various systems, platforms, and tools that work together to support a software product. At Tandem, documentation is more than just a best practice: it’s a way we demonstrate our values.

Insiders

Sign Up for our Newsletter

This site is protected by reCAPTCHA and the Google Privacy Policy and Terms of Service apply.

Trending Sources

article thumbnail

Code Documentation: How To Create Effective Handover Documentation

Praxent

Code Documentation : How To Create Effective Handover Documentation. Get our development team’s tips for documenting and completing a software handover involving custom code. This could be code linking two applications or systems, or code used for a proprietary software application. System Architecture.

How To 40
article thumbnail

Agile Misconception #2: We Don’t Need Documentation

Atomic Spin

Documentation means a lot of different things to different people. If you’ve used a waterfall software development process, you’re all too familiar with documentation. From requirements to systems architecture to design, you’re creating documentation at every step of the process. What Should You Document?

Agile 52
article thumbnail

Agile Misconception #2: We Don’t Need Documentation

Atomic Spin

Documentation means a lot of different things to different people. If you’ve used a waterfall software development process, you’re all too familiar with documentation. From requirements to systems architecture to design, you’re creating documentation at every step of the process. Agile Documentation Basics.

Agile 40
article thumbnail

Mastering Day 2 Operations with Cloudera

Cloudera

Day 0 — Design and Preparation: Focuses on designing and preparing for your installation, including gathering requirements, planning architecture, allocating resources, setting up network and security, and documentation creation. Documentation: create documentation detailing the installation process and system configurations.

Backup 81
article thumbnail

Eraser, a new collaboration startup for technical teams, has $4 million in seed funding and some traction

TechCrunch

One is a canvas where you can visually collaborate — you can create diagrams or system architecture. The second piece is the note editor, where you can turn those figures and diagrams into some kind of documentation or reference document. You can create wireframes to visualize front-end UI mock ups.