User:Emilio/Documentation
Intro.
The subject matter of documentation
[edit | edit source]Answering the question: what is worth documenting?
- A place
Characteristics
- Something is done
- They
The process
[edit | edit source]Initial considerations are:
Type of documentation source
[edit | edit source]- Physical: A physical or tangible project that can be examined, photographed, or measured.
- Document: Existing handwritten, painted, printed, or digital information, which can range from descriptive to technical.
- Recorded media: Captured and stored video or audio with descriptions of a project, its creation, operation or use.
- Social posts: Media produced for instant communication instead of formal documentation, published on commercial websites.
IP considerations
[edit | edit source]- Material in the public domain: These materials are free to copy, transform, remix and reuse on Appropedia.
- Copyrighted material: A person or organization may release this content for public reuse, or not.
- Openly licensed material: After you review the conditions, you'll know the extent to which these materials can be used.
Different skills might be necessary depending on your documentation goals, such as recording audio, video and photography, conducting an interview, digitizing and processing documents, reviewing legal terms for producing documentation, translation, technical illustration, etc. This guide will present non-exhaustive yet practical recommendations as you produce documentation for your project.