Upload File

Download - Open Source Documentation in Four Easy Steps (and one slightly more difficult one)

Transcript
Page 1: Open Source Documentation in Four Easy Steps (and one slightly more difficult one)

Open Source DocumentationOpen Source Documentation

in Four Easy Stepsin Four Easy Steps

Page 2: Open Source Documentation in Four Easy Steps (and one slightly more difficult one)

and one slightly more and one slightly more complicated one ...complicated one ...

Page 3: Open Source Documentation in Four Easy Steps (and one slightly more difficult one)

ReleaseRelease

`̀

ReviewReview

Information Information PlanPlan Content Content

SpecificationSpecification

WritingWriting

LaunchLaunch

ConceptConcept

PlanningPlanning

DevelopmentDevelopment

TestingTesting

TranslationTranslation&&

ProductionProduction

MaintenanceMaintenance

Page 4: Open Source Documentation in Four Easy Steps (and one slightly more difficult one)

Information Plan/ConceptInformation Plan/Concept

10%10%

Page 5: Open Source Documentation in Four Easy Steps (and one slightly more difficult one)

Content Specification/Content Specification/PlanningPlanning

(Isn't there some rule about cats in presentations?)(Isn't there some rule about cats in presentations?)

20%20%

Page 6: Open Source Documentation in Four Easy Steps (and one slightly more difficult one)

Writing/DevelopmentWriting/Development

50%50%

Page 7: Open Source Documentation in Four Easy Steps (and one slightly more difficult one)

Translation/Translation/Testing/Testing/LaunchLaunch

19%19%

Page 8: Open Source Documentation in Four Easy Steps (and one slightly more difficult one)

ReviewReview 1%1%

Page 9: Open Source Documentation in Four Easy Steps (and one slightly more difficult one)
Page 10: Open Source Documentation in Four Easy Steps (and one slightly more difficult one)
Page 11: Open Source Documentation in Four Easy Steps (and one slightly more difficult one)
Page 12: Open Source Documentation in Four Easy Steps (and one slightly more difficult one)
Page 13: Open Source Documentation in Four Easy Steps (and one slightly more difficult one)
Page 14: Open Source Documentation in Four Easy Steps (and one slightly more difficult one)

Problem ...Problem ...

Page 15: Open Source Documentation in Four Easy Steps (and one slightly more difficult one)
Page 16: Open Source Documentation in Four Easy Steps (and one slightly more difficult one)

Solved!Solved!

Page 17: Open Source Documentation in Four Easy Steps (and one slightly more difficult one)

Lots of problems … Lots of problems … Solved!Solved!

Page 18: Open Source Documentation in Four Easy Steps (and one slightly more difficult one)

Problem ...Problem ...

Page 19: Open Source Documentation in Four Easy Steps (and one slightly more difficult one)

Solved!Solved!

Page 20: Open Source Documentation in Four Easy Steps (and one slightly more difficult one)
Page 21: Open Source Documentation in Four Easy Steps (and one slightly more difficult one)
Page 22: Open Source Documentation in Four Easy Steps (and one slightly more difficult one)
Page 23: Open Source Documentation in Four Easy Steps (and one slightly more difficult one)
Page 24: Open Source Documentation in Four Easy Steps (and one slightly more difficult one)
Page 25: Open Source Documentation in Four Easy Steps (and one slightly more difficult one)
Page 26: Open Source Documentation in Four Easy Steps (and one slightly more difficult one)
Page 27: Open Source Documentation in Four Easy Steps (and one slightly more difficult one)
Page 28: Open Source Documentation in Four Easy Steps (and one slightly more difficult one)

Describe the problemDescribe the problem

Solve the problemSolve the problem

Give extra informationGive extra information

Page 29: Open Source Documentation in Four Easy Steps (and one slightly more difficult one)

ConceptConcept

TaskTask

ReferenceReference

Page 30: Open Source Documentation in Four Easy Steps (and one slightly more difficult one)
Page 31: Open Source Documentation in Four Easy Steps (and one slightly more difficult one)

Publican*Publican*

* Doesn't actually have anything * Doesn't actually have anything to do with beerto do with beer

Page 32: Open Source Documentation in Four Easy Steps (and one slightly more difficult one)
Page 33: Open Source Documentation in Four Easy Steps (and one slightly more difficult one)
Page 34: Open Source Documentation in Four Easy Steps (and one slightly more difficult one)
Page 35: Open Source Documentation in Four Easy Steps (and one slightly more difficult one)
Page 36: Open Source Documentation in Four Easy Steps (and one slightly more difficult one)
Page 37: Open Source Documentation in Four Easy Steps (and one slightly more difficult one)
Page 38: Open Source Documentation in Four Easy Steps (and one slightly more difficult one)
Page 39: Open Source Documentation in Four Easy Steps (and one slightly more difficult one)
Page 40: Open Source Documentation in Four Easy Steps (and one slightly more difficult one)
Page 41: Open Source Documentation in Four Easy Steps (and one slightly more difficult one)
Page 42: Open Source Documentation in Four Easy Steps (and one slightly more difficult one)
Page 43: Open Source Documentation in Four Easy Steps (and one slightly more difficult one)
Page 44: Open Source Documentation in Four Easy Steps (and one slightly more difficult one)
Page 45: Open Source Documentation in Four Easy Steps (and one slightly more difficult one)
Page 46: Open Source Documentation in Four Easy Steps (and one slightly more difficult one)
Page 47: Open Source Documentation in Four Easy Steps (and one slightly more difficult one)
Page 48: Open Source Documentation in Four Easy Steps (and one slightly more difficult one)
Page 49: Open Source Documentation in Four Easy Steps (and one slightly more difficult one)
Page 50: Open Source Documentation in Four Easy Steps (and one slightly more difficult one)
Page 51: Open Source Documentation in Four Easy Steps (and one slightly more difficult one)
Page 52: Open Source Documentation in Four Easy Steps (and one slightly more difficult one)
Page 53: Open Source Documentation in Four Easy Steps (and one slightly more difficult one)
Page 54: Open Source Documentation in Four Easy Steps (and one slightly more difficult one)
Page 55: Open Source Documentation in Four Easy Steps (and one slightly more difficult one)
Page 56: Open Source Documentation in Four Easy Steps (and one slightly more difficult one)

Process is kingProcess is king

Page 57: Open Source Documentation in Four Easy Steps (and one slightly more difficult one)

Get the right toolsGet the right tools

Page 58: Open Source Documentation in Four Easy Steps (and one slightly more difficult one)

Keep Keep it it

openopen

Page 59: Open Source Documentation in Four Easy Steps (and one slightly more difficult one)

Keep Keep it it

realreal

Page 60: Open Source Documentation in Four Easy Steps (and one slightly more difficult one)

Review constantlyReview constantly

Page 61: Open Source Documentation in Four Easy Steps (and one slightly more difficult one)

Lana BrindleyLana Brindley

[email protected]@redhat.com@Loquacities@Loquacities

+61 410 500 659+61 410 500 659


Top Related

Having Difficult Conversations - The University of …transctr/pdf/8 Difficult Conversations...v2.5 Your Difficult Conversation Identify one “difficult conversation” that you are
Having Difficult Conversations - The University of …transctr/pdf/8 Difficult Conversations...v2.5 Your Difficult Conversation Identify one “difficult conversation” that you are
GardaTM Closed Garden Gazebo - mygardenhome.de · Step 17: If you find it slightly difficult to slide the roof panels in, it will be easily done by 2 people. One on a step ladder
GardaTM Closed Garden Gazebo - mygardenhome.de · Step 17: If you find it slightly difficult to slide the roof panels in, it will be easily done by 2 people. One on a step ladder
Measuring Loudspeakers, Part One - Troels Gravesen · Measuring Loudspeakers, Part One. John Atkinson, November 1998. This series of articles was initially written (in slightly different
Measuring Loudspeakers, Part One - Troels Gravesen · Measuring Loudspeakers, Part One. John Atkinson, November 1998. This series of articles was initially written (in slightly different
“Cultural leadership is one of the most difficult parts of ...€¦ · “Cultural leadership is one of the most difficult parts of the job” AFL boss Gillon McLachlan on racism,
“Cultural leadership is one of the most difficult parts of ...€¦ · “Cultural leadership is one of the most difficult parts of the job” AFL boss Gillon McLachlan on racism,
Conflict of Interest: An Axiomatic Approachartisinternational.org/articles/Axelrod_Conflict_of_Interest.pdf · CONFLICT OF slightly less than INTEREST: one, and AXIOMATIC APPROACH
Conflict of Interest: An Axiomatic Approachartisinternational.org/articles/Axelrod_Conflict_of_Interest.pdf · CONFLICT OF slightly less than INTEREST: one, and AXIOMATIC APPROACH
One oil for all of your back of house needs · 2020. 4. 2. · Flavor profile Clean & neutral Mild taste Slightly grassy or nutty. Fishy smell when heated Slightly grassy or nutty
One oil for all of your back of house needs · 2020. 4. 2. · Flavor profile Clean & neutral Mild taste Slightly grassy or nutty. Fishy smell when heated Slightly grassy or nutty
TOTAL PHYSICAL RESPONSE Teaching is one of the easiest jobs in the world......Teaching WELL is one of the most difficult!
TOTAL PHYSICAL RESPONSE Teaching is one of the easiest jobs in the world......Teaching WELL is one of the most difficult!
Legal issues/diversity n Difficult class. Perhaps one of the most challenging. Get into statistics
Legal issues/diversity n Difficult class. Perhaps one of the most challenging. Get into statistics