Tag

Software Documentation

0 views collected around this technical thread.

Architecture & Thinking
Architecture & Thinking
Mar 25, 2025 · Fundamentals

Boost Diagram Creation with DeepSeek: Generate Mermaid Flowcharts, Sequence & Class Diagrams

This guide shows how programmers can leverage the DeepSeek large language model to automatically generate Mermaid code for flowcharts, sequence diagrams, class diagrams, and other visualizations, dramatically reducing manual diagramming effort and improving documentation efficiency.

AIDeepSeekDiagram Generation
0 likes · 10 min read
Boost Diagram Creation with DeepSeek: Generate Mermaid Flowcharts, Sequence & Class Diagrams
macrozheng
macrozheng
Jan 8, 2024 · Fundamentals

Boost Your Documentation Efficiency: Master PlantUML for Rapid Diagram Creation

This article introduces PlantUML, an open‑source tool that lets developers generate various UML diagrams directly from text, explains how to install the IntelliJ IDEA plugin, and provides step‑by‑step code examples for sequence, use‑case, class, activity, and mind‑map diagrams, complete with visual outputs.

IDEPlantUMLSoftware Documentation
0 likes · 13 min read
Boost Your Documentation Efficiency: Master PlantUML for Rapid Diagram Creation
Architecture Digest
Architecture Digest
Mar 22, 2022 · Fundamentals

10 Essential Guidelines for Effective Technical Documentation

This article presents ten practical principles for technical writing, covering clear sentence structure, proper use of pronouns and transition words, strong verbs, active voice, minimal adjectives and adverbs, well‑structured paragraphs, concise headings, appropriate lists and tables, effective use of images, consistent style, overall document architecture, and audience targeting.

Best PracticesSoftware Documentationdocumentation
0 likes · 45 min read
10 Essential Guidelines for Effective Technical Documentation
macrozheng
macrozheng
Sep 29, 2021 · Fundamentals

Boost Your Documentation: Master PlantUML for Fast UML Diagramming in IDEA

This guide introduces PlantUML, an open‑source text‑based UML tool, shows how to install its IntelliJ IDEA plugin, and provides step‑by‑step examples for creating sequence, use‑case, class, activity, and mind‑map diagrams, highlighting key syntax and the efficiency of code‑driven diagramming.

DiagrammingIDEAPlantUML
0 likes · 11 min read
Boost Your Documentation: Master PlantUML for Fast UML Diagramming in IDEA
Architects Research Society
Architects Research Society
Dec 7, 2020 · Fundamentals

Requirements Specification: User and System Requirements, Writing Methods, and Documentation

This article explains the process of documenting user and system requirements, distinguishes between user and system requirements, describes natural‑language and structured‑language specification methods, outlines guidelines for clear requirement statements, and introduces the software requirements specification (SRS) as a formal contract between stakeholders.

SRSSoftware Documentationrequirements engineering
0 likes · 7 min read
Requirements Specification: User and System Requirements, Writing Methods, and Documentation