Skip to content

1 KB

Machine-translated by Robotheca from the original in Chinese (opens in a new tab). License: MIT (opens in a new tab).

Engineering Documentation Title (5 points)

Problem Description

The documentation must enable others to understand design decisions, reproduce the environment, run simulations, debug CAN communication, and trace the development process. At minimum, maintain overall requirements, system architecture, coordinate systems, CAN protocol, and development records; ensure that parameters, interfaces, and code in the documentation remain consistent.

Deliverables

requirements.md, architecture.md, coordinate_system.md, can_protocol.md, development_log.md, as well as the final demonstration steps, fault handling, and known limitations documentation.

Scoring

ItemScore
Complete requirement coverage and clear structure1
Architecture, coordinate system, and interface documentation1
CAN protocol implementable and consistent with code1
Build, run, test, and demo steps1
Development notes, limitations, and maintainability1

Files by @wusi321, at commit b6b12b0, read from GitHub in your browser. Hardware license: MIT; software license: MIT. Robotheca doesn't review code: read it before running it.