Plantilla-Documentación

	A	B	C	D	E	F	H
1	Document type	Section	Audience	Content	Status	Comments
2	Project documentation	Overview	General community	Definition of the project or general objective. Explanation of what you did, what it is for. General overview.			The main idea is that this documentation template helps you to guide yourself in what you have to document about what you did. Not all sections can be adapted to what you did, but the idea is that you can back up the things you did with a proper documentation. This documentation template must be taken into consideration every time you document something. Eg. I made a free cad file of a part of the robot - - I go section by section writing down all the things that are highlighted in the "content" column.
3	Instructions	Usage	Users	Intended instructions for use, alternative use modalities, use restrictions (related to design justification, functional specification and operating principle elements). -Solve problems Clarify if there might be any problem with the use of what you did and how can you adapt if you have a problem - Precautions Indicate if there are any precautions to be taken while doing what you did
4	Technical documentation	Assembly	Makers, Users	Full description of assembly steps, parts, and required knowledge, skills, time, and tools.
5	Technical documentation	Interfaces	Makers, Users	Indicate how it connects to other parts of the robot, and all parameters relevant to those interactions and/or interfaces. Also comment in which section of the documentation you think your material goes (Assembly, Maintenance, Design, Development…)
6	Technical documentation	Maintenance	Technical support, Users	Required maintenance operations, frequency, tester replacement parts and alternatives.
7	Technical documentation	Design	Developers, Contributors, Educators	Description of the overall design rationale. List of the main design choices and implications (e.g. functional compromises). Minimal explanation of the working principles
8	Source files	Design files	Developers, Contributors	Design files with parts metadata, typically including: the specifications of parts and materials. Distinguish between custom parts (e.g. developed as a result of this or another project), off-the-shelf parts (e.g. screws), or complex modules (e.g. a single board computer).
9	Technical documentation	Development	Developers	Development tools (e.g. DE, EDA, or CAD software) and style guidelines. Files + complementary information (e.g. measurements of the pieces, explanations of the images, etc.)
10
11	Overview	Document type: Project documentation	Audience: General community	Content: Definition of the project or general objective. Explanation of what you did, what it is for. General overview.
12	Usage	Document type: Instructions	Audience: Users	Content: Intended instructions for use, alternative use modalities, use restrictions (related to design justification, functional specification and operating principle elements). -Solve problems Clarify if there might be any problem with the use of what you did and how can you adapt if you have a problem - Precautions Indicate if there are any precautions to be taken while doing what you did
13	Assembly	Document type: Technical documentation	Audience: Makers, Users	Content: Full description of assembly steps, parts, and required knowledge, skills, time, and tools.
14	Interfaces	Document type: Technical documentation	Audience: Makers, Users	Content: Indicate how it connects to other parts of the robot, and all parameters relevant to those interactions and/or interfaces. Also comment in which section of the documentation you think your material goes (Assembly, Maintenance, Design, Development…)
15	Maintenance	Document type: Technical documentation	Audience: Technical support, Users	Content: Required maintenance operations, frequency, tester replacement parts and alternatives.
16	Design	Document type: Technical documentation	Audience: Developers, Contributors, Educators	Content: Description of the overall design rationale. List of the main design choices and implications (e.g. functional compromises). Minimal explanation of the working principles
17	Design files	Document type: Source files	Audience: Developers, Contributors	Content: Design files with parts metadata, typically including: the specifications of parts and materials. Distinguish between custom parts (e.g. developed as a result of this or another project), off-the-shelf parts (e.g. screws), or complex modules (e.g. a single board computer).
18	Development	Document type: Technical documentation	Audience: Developers	Content: Development tools (e.g. DE, EDA, or CAD software) and style guidelines. Files + complementary information (e.g. measurements of the pieces, explanations of the images, etc.)
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100