Documentation is the process of creating, maintaining, and storing written records of a project's development, including requirements, design, implementation, testing, and maintenance. It serves as a reference for developers, stakeholders, and users, ensuring that everyone involved in the project has access to accurate and up-to-date information about the system's functionality and structure.
Below is an overview of content that matches the tag "documentation".
Note that this list is not exhaustive, as it is automatically aggregated based on manually assigned categorizations.
If you notice a missing element, or think some of the items are wrongfully categorized, please create a bug/improvement ticket on our github issue tracker.
Patterns tagged with "documentation"
problem:You are experiencing difficulty in keeping track of which changes have been made to your project.
description:Maintaining a Changelog in your project’s codebase ensures clear documentation of significant changes, enhancing traceability, collaboration, and efficient release management.
problem:You are looking for ways to enhance productivity by reducing meeting time, interruptions, and communication overhead.
description:Creating minimal but effective design documentation to track and communicate decisions in software development, reducing the need for excessive meetings and improving team alignment.
Books tagged with "documentation"
Design It
From Programmer to Software Architect
Keeling, M. (2017) Design It. The Pragmatic Bookshelf. isbn: 1680502093.
In “Design It,” author Michael Keeling provides valuable insights into the essential responsibilities of a software architect.
Through the lens of a hypothetical project, readers embark on a journey through various project stages.
The book strikes a balance between theoretical knowledge, practical methodologies, and a profound exploration of guiding principles.
Keeling skilfully conveys the pivotal role of a software architect, highlighting their ability to bridge the gap between the business’s requirements,
the technical team’s needs, and the broader operational context. “Design It” offers readers a comprehensive understanding of software architecture,
making it a valuable resource for programmers aspiring to become adept software architects, as well as for experienced architects wishing to refresh
their knowledge of modern techniques.
Other Resources tagged with "documentation"
SD Development Document generator
Tooling to generate documents from Markdown, using docker images to ensure portability between different environments. Contains a quick-start set-up. Useful for automated pipelines or quick set-up on new computers.
Structurizr
A DSL for describing software architecture and design. Based on the c4model system for system description. Easy to use, and integrates with the most popular code-to-diagram formats.
Business Process Model And Notation Specification - Version 2.0
The BPMN (Business Process Model and Notation) 2.0 specification website by OMG (Object Management Group) provides detailed documentation on the BPMN standard, which is widely used for modeling business processes. This standard offers a graphical notation that is understandable to all business stakeholders, enabling them to collaborate and understand processes clearly. BPMN 2.0 supports both technical and business-level communication.
The C4 model for visualising software architecture
The C4 Model website outlines a method for visualizing software architecture through four distinct diagram types: Context, Container, Component, and Code. This model simplifies the complexity of software systems by offering different levels of abstraction, making it easier for teams to communicate and understand architectural designs. Knowledge workers will find it useful for maintaining clarity and consistency in documentation and for facilitating effective collaboration across development teams.