ARMmbed
/
mbed-os
mirror of https://github.com/ARMmbed/mbed-os.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

Copy edit design-template.md 

Copy edit file for consistency, grammar, spelling and voice.
pull/7561/head
Amanda Butler 2018-08-24 10:52:57 -05:00 committed by GitHub
parent 072cbb4d57
commit 43974e3137
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 129 additions and 117 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

246
docs/design-documents/design_template.md
View File

@ -1,78 +1,80 @@
# Mbed-OS Design Document
Write your feature title above, in this case its "Mbed-OS Design Document"
# Mbed OS design document
# Table of Contents
- [Mbed-OS Design Document](#mbed-os-design-document)
- [Table of Contents](#table-of-contents)
- [Revision history](#revision-history)
- [Introduction](#introduction)
- [Overview and Background](#overview-and-background)
- [Requirements and Assumptions](#requirements-and-assumptions)
- [System Architecture and High-Level Design](#system-architecture-and-high-level-design)
- [System Architecture and Component Interaction](#system-architecture-and-component-interaction)
- [Detailed Design](#detailed-design)
- [Usage Scenarios and Examples](#usage-scenarios-and-examples)
- [Tools and Configuration Changes](#tools-and-configuration-changes)
- [Other Information](#other-information)
- [Reusability](#reusability)
- [Deprecations](#deprecations)
- [References](#references)
- [Custom Headings Here](#custom-headings-here)
Write your feature title above. In this case, its "Mbed OS design document."
# Table of contents
1. [Mbed OS design document](#mbed-os-design-document).
1. [Table of contents](#table-of-contents).
1. [Revision history](#revision-history).
1. [Introduction](#introduction).
1. [Overview and background](#overview-and-background).
1. [Requirements and assumptions](#requirements-and-assumptions).
1. [System architecture and high-level design](#system-architecture-and-high-level-design).
1. [System architecture and component interaction](#system-architecture-and-component-interaction).
1. [Detailed design](#detailed-design).
1. [Usage scenarios and examples](#usage-scenarios-and-examples).
1. [Tools and configuration changes](#tools-and-configuration-changes).
1. [Other information](#other-information).
1. [Reusability](#reusability).
1. [Deprecations](#deprecations).
1. [References](#references).
1. [Custom headings](#custom-headings).
### Revision history
1.0 - A brief description for this version, e.g. Initial revision - Author name - Date. NOTE: You may also specify the Mbed OS version this revision of design-document applies to.
1.1 - Added new section - Author name - Date
1.0 - A brief description of this version. For example, Initial revision - Author name - Date.
**NOTE: You may also specify the Mbed OS version this revision of design document applies to.**
1.1 - Added new section - Author name - Date.
# Introduction
### Overview and Background
Provide a background of this feature. Briefly explain why this feature is needed, what is it accomplishing, what problem its solving. If you already have a requirement written for this feature you may also use the contents of the requirement to provide user with overall context of why this feature is needed.
For example:- This document provides a template for writing software design documents for Mbed-OS features.
### Requirements and Assumptions
Capture the requirements for this feature to work and other assumptions made. For example, if you are assuming specific
hw capabilities, memory requirements, security assets like presence of RoT infrastructure, then capture those here.
For example:- This feature requires QuadSPI interface on the target as it implements block device driver over QuadSPI
interface. It also assumes the system can provide 16K of memory for buffering.
### Overview and background
# System Architecture and High-Level Design
This section provides high level information on areas or components needing changes or new development to implement this
feature. The idea here is to capture the high level design goals of this feature for the target reader, the focus here should
be what functionality it provides and not the actual implementation. For example, if you are implementing a new device driver
for a communication peripheral/device then the high level design goals could be as below. Add more descrption to each high level design goal if required.
Provide a background of this feature. Briefly explain why this feature is necessary, what it accomplishes and what problem it solves. If you already have written a requirement for this feature, you may also use the contents of the requirement to provide the user with the overall context of why this feature is necessary.
* `Configuring the device` - The driver should provide a specific interface to configure the communication paramaters for the device.
* `Starting and stopping the device` - The driver should provide interfaces to start and stop all the communications.
* `Reading from and Writing to the device` - Read and Write interfaces should be implemented to support sending single/multiple bytes.
* `Resetting the device` - Functionality to reset the device should be provided.
For example:
**NOTE: If you already have publicly available supporting architecture documentation in the form of technology documents or other existing documents
feel free to link them here and use that, you don't have to replicate the same documentation here. **
This document provides a template for writing software design documents for Mbed OS features.
For each high level design goal, provide detailed software design under [Detailed Design](#detailed-design) section providing more details on implementation.
### Requirements and assumptions
### System Architecture and Component Interaction
Description and diagrams showing overall architecture of how the above-mentioned components/resources interface with each other.
For, example if the new feature is to implement a driver and if it provides interfaces with application and uses memory subsystem in OS
to talk to the device the diagram may look something like below. The goal here is to capture high level components and their interaction and not the
minute details.
Capture the requirements for this feature to work and other assumptions made. For example, if you are assuming specific hardware capabilities, memory requirements or security assets, such as the presence of a Root of Trust infrastructure, then capture those here.
![System Architecture and Component Interaction](./diagram_examples/system_arch_example.jpg)
For example:
# Detailed Design
This section provides detailed design on implementation of each of the high level design goal mentioned above.
Each components/modules needing changes are also captured in details. The target audience here is a developer
who can read this section and start the real implemention. You can capture things like signature of interfaces,
flow charts showing how the APIs work, data flow diagrams etc. The headings for each detailed design section
should match the headings in high level design goals. For example, based on the example provided above,
the headings for details design sections should be `Configuring the device`, `Starting and stopping the device`,
`Reading from and Writing to the device`, `Resetting the device`.
This feature requires a QuadSPI interface on the target because this feature implements a block device driver over the QuadSPI interface. It also assumes the system can provide 16K of memory for buffering.
### Detailed Design 1 - e.g, `Configuring the device`
# System architecture and high-level design
**API Description**
Detailed API Description like signature of interface, explanation of arguments, return codes etc.
For example, if you are trying to define an interface for configuring the device, you may describe
the API as below.
This section provides high-level information about areas or components that need changes or new development to implement this feature. Capture the high-level design goals of this feature for the target reader. Focus on what functionality it provides and not the actual implementation. For example, if you are implementing a new device driver for a communication peripheral or device, then the high-level design goals may look like:
- `Configuring the device` - The driver should provide a specific interface to configure the communication paramaters for the device.
- `Starting and stopping the device` - The driver should provide interfaces to start and stop all the communications.
- `Reading from and Writing to the device` - Read and Write interfaces should be implemented to support sending single and multiple bytes.
- `Resetting the device` - Functionality to reset the device should be provided.
Add more description to each high-level design goal if required.
**NOTE: If you already have publicly available supporting architecture documentation in the form of technology documents or other existing documents, please link to them instead of replicating the documentation.**
For each high-level design goal, provide a detailed software design in the [detailed design](#detailed-design) section, including more details on implementation.
### System architecture and component interaction
Description and diagrams showing overall architecture of how the components and resources interface with one another. This section captures high-level components and their interaction and not the minute details. For example, if the new feature implements a driver and provides interfaces with application and uses memory subsystem in OS to talk to the device, the diagram may look something like:
![System architecture and component interaction](./diagram_examples/system_arch_example.jpg)
# Detailed design
This section provides a detailed design on the implementation of each of the high-level design goals. This section also captures each component or module needing changes in detail. The target audience is a developer who can read this section and start the implemention. You can capture the signature of interfaces, flow charts showing how the APIs work, data flow diagrams and so on. The headings for each detailed design section match the headings in the high-level design goals. For example, based on the example above, the headings for the detailed design sections aree `Configuring the device`, `Starting and stopping the device`, `Reading from and Writing to the device` and `Resetting the device`.
### Detailed design 1 (For example, `Configuring the device`)
**API description**
Detailed API description, such as the signature of the interface, explanation of arguments, return codes and so on. For example, if you are defining an interface for configuring the device, you may describe the API like this:
`Configure API should have following signature:
mbed_error_status_t configure(int speed, enum flow_control_t flow_control, int parity_bits);`
@ -86,53 +88,55 @@ the API as below.
MBED_ERROR_INVALID_ARGUMENT if input values are invalid.`
MBED_ERROR_CONFIG_UNSUPPORTED if the device doesnt support the requested configuration.`
**Configuration Sequence Diagram**
**Configuration sequence diagram**
Sequence Diagrams, Data flow diagrams etc. For example, the flow chart for configure device API above may
be something like below.
Sequence diagrams, data flow diagrams and so on. For example, the flow chart for configure device API above may look something like:
![Configure device operation](./diagram_examples/flow_chart_example.jpg)
### Detailed Design 2 - e.g, `Starting and stopping the device`
### Detailed design 2 (For example, `Starting and stopping the device`)
**API Description**
Detailed API Description like signature of interface, explanation of arguments, return codes etc
For example, for start and stop functions exported by the driver.
**API description**
**Sequence Diagrams for `Starting and stopping the device`**
Sequence Diagrams, Data flow diagrams etc. For example, the sequence digram for stopping the device may look
something like below.
Detailed API description, such as the signature of the interface, explanation of arguments, return codes and so on. For example, for start and stop functions exported by the driver.
**Sequence diagrams for `Starting and stopping the device`**
Sequence diagrams, data flow diagrams and so on. For example, the sequence digram for stopping the device may look something like:
![Stopping the device](./diagram_examples/sequence_diagram_example.jpg)
### Detailed Design 3 - e.g, `Reading from and Writing to the device`
### Detailed design 3 (For example, `Reading from and Writing to the device`)
**API Description**
Detailed API Description like signature of interface, explanation of arguments, return codes etc
**API description**
**Sequence Diagram for `Reading from and Writing to the device`**
Sequence Diagrams, Data flow diagrams etc.
Detailed API description, such as the signature of interface, explanation of arguments, return codes and so on.
### Detailed Design N - e.g, `Resetting the device`
**Sequence diagram for `Reading from and Writing to the device`**
**API Description**
Detailed API Description like signature of interface, explanation of arguments, return codes etc
Sequence diagrams, Data flow diagrams and so on.
**Sequence Diagram for `Resetting the device`**
Sequence Diagrams, Data flow diagrams etc.
### Detailed design N (For example, `Resetting the device`)
# Usage Scenarios and Examples
Show pseudo-code or flowcharts explaining the usage of the feature. For example you may want to include
some pseudo code to demonstrate how the read functionality is used with the new driver design you are
proposing.
**API description**
### Scenario 1 - e.g, `Reading from the device`
Mention the specific usage scenarios here. For example, the below examples shows how to read data from
device using the new APIs.
Detailed API description, such as the signature of the interface, explanation of arguments, return codes and so on.
**Scenario 1 Example 1. - e.g, `Reading a byte from device`**
Mention the specific usage here. For example, the below example shows pseudo-code for how to read a single byte data from
the device using the new APIs.
**Sequence diagram for `Resetting the device`**
Sequence diagrams, data flow diagrams and so on.
# Usage scenarios and examples
Show pseudocode or flowcharts explaining the use of the feature. For example, you may want to include some pseudocode to demonstrate how to use the read functionality with the new driver design you are proposing.
### Scenario 1 (For example, `Reading from the device`)
Mention the specific use scenarios. For example, the below examples shows how to read data from device using the new APIs.
**Scenario 1 example 1. (For example, `Reading a byte from device`**)
Mention the specific use. For example, the below example shows pseudocode for how to read a single byte data from the device using the new APIs.
```C
char in_byte = 0;
@ -142,8 +146,10 @@ if(num_bytes_read == 1) {
...
}
```
**Scenario 1 Example 2. - e.g, `Reading multiple bytes from device`**
In this example, the pseudo-code below shows how to read multiple bytes of data from the device using the new APIs.
**Scenario 1 example 2 (For example,`Reading multiple bytes from the device`**)
In this example, the pseudocode below shows how to read multiple bytes of data from the device using the new APIs.
```C
char in_bytes[NUM_BYTES];
@ -153,42 +159,48 @@ if(num_bytes_read == NUM_BYTES) {
...
}
```
### Scenario 2 - e.g, `Writing to the device`
Mention another usage scenarios here. For example, you can demostrate how to write to the device
and few examples of usage.
**Scenario 2 Example 1. - e.g, `Writing a byte to device`**
Demonstrate the specific example here. For example, how to write a byte of data to device.
### Scenario 2 (For example, `Writing to the device`)
**Scenario 2 Example 2. - e.g, `Writing multiple bytes to device`**
Demonstrate another specific example here. For example, how to write mutiple bytes of data to device.
Mention other usage scenarios here. For example, you can demostrate how to write to the deviceand few examples of usage.
# Tools and Configuration Changes
Explain which tools needs to be changed and the nature of changes.
For example, if the feature requires adding a new sub-command to mbed-cli capture
the details of changes and usage here. Each tool change can be captured under its own
sub-heading as below. You can also capture new configuration values which needs to be
added to mbed json based configuration system. For each, config value added explan
the name of the config value and how to use it and its relation to any pre-processor
defines in the implementation.
**Scenario 2 example 1 (For example,`Writing a byte to device`**)
### Tool Change 1 - e.g: - Command line additions/changes
Demonstrate the specific example, for example, how to write a byte of data to device.
### Configuration Changes e.g: - Configuration changes in Json files etc
**Scenario 2 example 2 (For example, `Writing multiple bytes to device`**)
Demonstrate another specific example, for example, how to write mutiple bytes of data to device.
# Tools and configuration changes
Explain which tools need to change and the nature of changes. For example, if the feature requires adding a new subcommand to Arm Mbed CLI, capture the details of changes and use. Capture each tool change under its own subheading as below. You can also capture new configuration values that need to be added to the Mbed .json-based configuration system. For each configuration value added, explan
the name of the configuration value, how to use it and its relation to any preprocessor defines in the implementation.
### Tool change 1
For example, command-line additions and changes
### Configuration changes
For example, configuration changes in .json files
# Other information
# Other Information
Add other relevant information you would like to capture. Add custom headings if required.
### Reusability
List the components or pieces of implementation which can be re-used for specific
design patterns/other implementations.
List the components or pieces of implementation that can be reused for specific design patterns or other implementations.
### Deprecations
List the APIs which may be deprecated as part of this feature.
List the APIs that may be deprecated as part of this feature.
### References
Capture information such as specifications, other design docs, other implementations Urls etc.
### Custom Headings Here
Add your custom headings here, for example security impacts of this feature can be put
under the heading `Security Impacts`.
Capture information, such as specifications, other design documentation and other implementations URLs.
### Custom headings
Add custom headings. For example, you can put security effects of this feature under the heading `Security effects`.