Documentation

From Transmission
Jump to: navigation, search

Documentation working group

initially difficult Connection with presenter adam hyde in Norway showing flossmanuals site. Lines breaking, feedback from speakers etc, losing him…

Floss manuals, supporting developers, creating documentation that can be remixed for workshops, other aims, recommends that trx network adopts floss manuals under gpl, cc license. Gpl

Platform Built on twiki, stable and reliable. Has to be more regulated than wikipedia, looking to make another repository that is completely open…

Contributor copyright is maintained, but platform allows reuse. Getting plugin to enable remixing of chapters to make own pdf into own manual.

What makes a good manual? Never leave a step explained. Even how to use a mouse. How to download, install and confugure software. No explanation is simple enough, but fine line not to go too far.

Explain jargon, use it but explain it. Nice style and layout.

Explain context, paradigm and usage of software. Eg what is an audio editor, and how does it think about things…

Use icons, and explain images in text to enable blind users. TEST manuals.

Need arts etc funding, commission artists etc to get involvement, hope to commission artists to write manuals.. has 14 k euro already. Hiring translater next month, launching in December.

Video documentation not best way for web, better model is screen shots in slideshow with text explanations and graphics. Take own time, and easy to translate

Proposal to have focused documentation session, sprint/chill out lounge, allow tx people to share their experience test stuff, wsii spaces, saul knows….physical spaces and resources to help these developments.

Broad networks share

Problem of lack of documentation, hasn’t been done, needs to be professional and reliable, raise it to another level, then so many avenues for it…

Outcomes:

Adam to keep tx network up to date on developments,

Saul contact for wsii spaces idea,

Plan for a documentation brainstorm/sprint.chill, late march or april when he gets back from Antarctica.. doing arts and science projects there, making space for all that…

Zoe contact for the user-focused way into the material, Adam has been talking to people about this and is keen…..

audio file

Personal tools