[WIP] OffDotNet Architecture #192
victor-pogor
announced in
Architecture
Replies: 0 comments
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
-
Introduction and Goals
This document describes OffDotnet, a C# library for generating and editing PDF documents.
The library must be fast, memory-efficient, easy to use, customizable, and highly extensible by community plugins.
OffDotnet is primarily intended to support the PDF 1.7 (ISO 32000-1:2008) specification.
Requirements Overview
into consideration when implementing the PDF objects
the library functionality (i.e. styles, tables, etc.)
Quality Goals
Stakeholders
Architecture Constraints
main
branch must pass the Quality GateSystem Scope and Context
Business Context
Technical Context
Solution Strategy
Building Block View
Whitebox Overall System
<Overview Diagram>
Motivation
<text explanation>
Contained Building Blocks
<Description of contained building block (black boxes)>
Important Interfaces
<Description of important interfaces>
<Name black box 1>
<Purpose/Responsibility>
<Interface(s)>
<(Optional) Quality/Performance Characteristics>
<(Optional) Directory/File Location>
<(Optional) Fulfilled Requirements>
<(optional) Open Issues/Problems/Risks>
<Name black box 2>
<black box template>
<Name black box n>
<black box template>
<Name interface 1>
…
<Name interface m>
Level 2
White Box <building block 1>
<white box template>
White Box <building block 2>
<white box template>
…
White Box <building block m>
<white box template>
Level 3
White Box <_building block x.1_>
<white box template>
White Box <_building block x.2_>
<white box template>
White Box <_building block y.1_>
<white box template>
Runtime View
<Runtime Scenario 1>
<insert runtime diagram or textual description of the scenario>
<insert description of the notable aspects of the interactions
between the building block instances depicted in this diagram.>
<Runtime Scenario 2>
…
<Runtime Scenario n>
Deployment View
Infrastructure Level 1
<Overview Diagram>
Motivation
<explanation in text form>
Quality and/or Performance Features
<explanation in text form>
Mapping of Building Blocks to Infrastructure
<description of the mapping>
Infrastructure Level 2
<Infrastructure Element 1>
<diagram + explanation>
<Infrastructure Element 2>
<diagram + explanation>
…
<Infrastructure Element n>
<diagram + explanation>
Cross-cutting Concepts
<Concept 1>
<explanation>
<Concept 2>
<explanation>
…
<Concept n>
<explanation>
Architecture Decisions
Quality Requirements
Quality Tree
Quality Scenarios
Risks and Technical Debts
Glossary
About arc42
arc42, the template for documentation of software and system
architecture.
Template Version 8.2 EN. (based upon AsciiDoc version), January 2023
Created, maintained and © by Dr. Peter Hruschka, Dr. Gernot Starke and
contributors. See https://arc42.org.
Beta Was this translation helpful? Give feedback.
All reactions