📚 Developer Documentation Guide

This guide outlines best practices for documenting your software projects at Konfío. Following these guidelines ensures consistency, maintainability, and ease of knowledge sharing across teams. Let’s explore each aspect of documentation in detail.

Overview

Diagramming Tools

Choose the appropriate diagramming tool based on your needs:

Visual Diagramming

• https://www.lucidchart.com/pages/
• https://miro.com/
• https://www.tldraw.com/
• https://www.draw.io/
• https://excalidraw.com/

Diagramming as Code

• D2: https://d2lang.com/
• PlantUML: https://plantuml.com/en/
• https://www.mermaidchart.com/
• Lucidchart: Professional diagrams with real-time collaboration - https://www.lucidchart.com
• Mermaid: Code-based diagrams integrated with markdown - https://mermaid.js.org. You may also leverage AI LLMs that generate snippets for diagrams.
• Draw.io: Versatile diagramming with extensive shape libraries - https://draw.io
• Excalidraw: Hand-drawn style diagrams for whiteboarding - https://excalidraw.com
• Miro: Collaborative boards for system design and workflows - https://miro.com