Learning Preparation

Documentation and Hardware Technology

Used to document the progress of a project. Entries usually include:

Date

Description of progress since last entry

Tasks achieved

Descriptions of stumbling blocks or issues encountered + how they were managed

Details of possible approaches for upcoming tasks

Reflective comments

Reference to resources used

User manual

Reference manual

Installation guide

Tutorials

Online help

System documentation

Algorithms

Source code

Software that allows for the development of a software tools

Generate modelling tools and docs automatically based on code

Software that assists in writing code (eg. VS Code, Xcode)

Create system docs manually with chart drawing tools (diagrams.net, Lucidchart, etc.)

Any software that assists in creating documentation

Documentation gives the developer an explicit opportunity to address social and ethical issues

eg. Recognising contributing devs, Creating inclusive software through user docs, Clearly stating copyright and licensing

Minimum performance and hardware to run a piece of software.

⁠

Minimum requirements for Final Cut Pro

Minimum requirements for Final Cut Pro

⁠

Other hardware required for specific features or for higher performance.

⁠

Excerpt from Final Cut Pro changelog that displays additional hardware required for some features.

Excerpt from Final Cut Pro changelog that displays additional hardware required for some features.

⁠

Want to print your doc?
This is not the way.

Try clicking the ⋯ next to your doc name or using a keyboard shortcut (

CtrlP

) instead.