---
# System prepended metadata

title: Instruction for Software Development Log
tags: [NTURT, development_log]

---

# Instruction for Software Development Log
###### tags: `development_log` `NTURT`
## Software subsystems

```graphviz
digraph hierarchy {

nodesep=1.0 // increases the separation between nodes
node [color=Blue,fontname=Times,shape=box] // all nodes will this shape and color
edge [color=Blue, style=continuous] // all the lines look like this

NTURT->{on_car not_on_car}
on_car->{BMS axle_box RPI}
not_on_car->{administration server docker}
}
```

---

# National Taiwan University Racing Team Software Development Log
###### tags: `development_log` `NTURT`
##### Group: *enter group*
##### Person in charge: *enter persion in charge*
##### Authors: *enter authors of the project*
##### Subsystem: *enter subsystem name*
##### Subsystem number: *enter subststem number*
##### Software name: *enter software name*
##### Repository: *put url to repository here*
##### Started designing date: *enter started designing date*
##### Current version: *enter current version*
##### Last modified date: *enter last modified date*
---

## Engineering goal:

> Enter engineering goal

## Program structure:

> Enter program structure

## Included libraries:

> Enter used libraries and their version

## Algorithm references

> Enter algorithm references

## Testing environment:

> Enter used testing programs and version

##### Testing hardware:

> Enter computer, raspberry pi, microcontroller, etc.

##### Operating system:

> Enter operating system

##### Compiler(intepreter) version:

> Enter compiler such as gcc or intepreter such as python ans their version

---

## Change date of O.O: *Enter change date of the version*

## Changes in O.O:

> Enter changes of the version

## Change reasons of O.O:

> Enter change reason of the version

## Testing result of O.O:

> Enter change result of the version

## Todos in O.O:

> Enter todos of the version

## The following are instructions(please delete in real software development log)
### To be finished in the first version

- Engineering goal
- Software structure
- Included libraries
- Algorithm references
- Testing environment
- Testing result of O.O
- Todos in O.O

### To be finished after the first version

Please separate each version by a separate line, checkout the exapmle

- Change date of O.O
- Changes in O.O
- Change reasons of O.O
- Testing result of O.O
- Todos in O.O

> If there were other changes, pease also list here

### Version rule
#### Version format: X.Y, please start from 1.0
#### Major changes: X+1 (Y start from zero)

- New functionalities
- Change algorithm
- Change API(application programming interface)

#### Minor changes: Y+1

- debug
- documentations

#### Software development log example

[docker_virutal_environment](https://hackmd.io/@nturacing/S1KRT8y0q)

## Sync with github

Please refer to: [Sync a Note with GitHub](https://hackmd.io/c/tutorials/%2Fs%2Flink-with-github)
and sync the software development log on github to [Software Development Log List](https://hackmd.io/@nturacing/SJDqgP109)
