Upload File

open source documentation in four easy steps (and one slightly more difficult one)

  • Home
  • Technology
  • Open Source Documentation in Four Easy Steps (and one slightly more difficult one)
61
Open Source Documentation Open Source Documentation in Four Easy Steps in Four Easy Steps

Upload: lana-brindley

Post on 05-Dec-2014

4.032 views

Category:

Technology


0 download

Report

DESCRIPTION

In the world of open source documentation, it is important to have a solid process that works. Lana Brindley will discuss how things are done at the world's leading open source company, including some of the challenges they face in getting the right document into the right hands at the right time, all while keeping it open, and keeping it real. http://openhelpconference.com/sessions.html#lana_brindley

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


One Nation, Slightly Divisible. - RIC · 2011-10-13 · THE ATLANTIC MONTHLY ONE NATION, SLIGHTLY DIVISIBLE The electoral map of the 2000 presidential race became famous: big blocks

mosquito-va.orgmosquito-va.org/wordpress/wp-content/uploads/2019...  · Web viewDirections . 800 Carolina Rd, Suffolk Virginia may be slightly difficult to find once you get close

Dealing with Difficult Parents - safenotscared.comsafenotscared.com/DealingwithDifficultParents.pdf · Dealing With Difficult Parents One of the most unenviable components ... Every

PRESENTS Taking the difficult out of difficult conversationsacademicaffairs.ucsf.edu/ccfl/media/lectures/Difficult... · Taking the difficult out of difficult conversations ... •

Entitled - srufaculty.sru.edusrufaculty.sru.edu/david.dailey/words/Lexicographic adventuresIII.docx  · Web viewWhen one enters a word like “wild” one sees the best ... is slightly

Slightly Off Target

PRACTICAL TRANSISTOR RECEIVERS Practical-Transitor-Receiver-Book-1.pdf · least a three -gang condenser, which is both bulky and difficult to align. They are, however, slightly cheaper

IAOM Presentation Chris Heming, MD Packaging Inc.•Non-ferrous –Aluminum, copper, tin, lead, brass and silver Non-ferrous metals are conductive, but not magnetic Slightly more difficult

The Essential Guide To Buying A Laptop - makeuseof.com€¦ · laptop, the downside is that the components are slightly more expensive and less powerful. It can also be difficult

Legal issues/diversity n Difficult class. Perhaps one of the most challenging. Get into statistics

Protista is one kingdom in the domain Eukarya. Protists are difficult to classify

Mimi’s Mr. & Mrs. - Dollmakers Journey · Mimi’s “Rolls Royce” of stuffing. It Mr. & Mrs. pattern has two optional faces: an easy needle-modeled face and a slightly more difficult

Welcome One And All 1. UN Sunday Tackling the Difficult Issues October 20, 2013 2

Properties Water - polar molecule - opposite ends have opposing charges. One end - slightly positive; other - slightly negative. Ends attracted to one

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

Multiple meaning words can be one of the most difficult language

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

What makes difficult asthma difficult?

The Economy - Yearbook34 The Economy 3 Total exports of goods grew slightly in 2016, reversing a modest decline in 2015. The external trading environment was particularly difficult

Handling Difficult Peoplehillviewmethodist.org/.../Dealing-with-Difficult-People.pdfHandling Difficult People Hillview Leadership Class Listening Listening is step one in dealing with

VERY SLIGHTLY MEDIUM SLIGHTLY STRONGLY ACID ... pH...ALKALI VERY SLIGHTLY ACID VERY SLIGHTLY ALKALI RHODODENDRONS POTATOES CARROTS HYDRANGEA (BLUE) HYDRANGEA (PINK) AZALEA & ERICA

CHAPTER ONE Growing and Studying in Difficult Times

— WHEN...Basel import. Very slightly corroded capsules. Slightly bin-soiled labels, one is slightly marked. levels : one base of neck, two top, two just below top and one upper-shoulder

GET RID OF GAMBLING ADDICTION - Overcome One Of The Most Difficult Addictions Today!

Three Models for Having Difficult Conversations - … Models for Having Difficult Conversations - Successfully ... •If you could change one thing about the direction of ... • It

Overhead-Contact Systems Design · of the cable supports' structures ... specially difficult to calculations: one the one hand, ... catenary’s type systems and

Conflict of Interest: An Axiomatic Approachartisinternational.org/articles/Axelrod_Conflict_of_Interest.pdf · CONFLICT OF slightly less than INTEREST: one, and AXIOMATIC APPROACH

Handling Difficult Tutoring Situations & Difficult Students difficult... · Handling Difficult Tutoring Situations & Difficult ... Handling Difficult Tutoring Situations & Difficult

Saladin 5e Extended Outline  · Web view2020. 9. 1. · A hydrogen bond is a weak attraction between a slightly positive hydrogen atom in one molecule and a slightly negative oxygen

Handling Difficult Tutoring Situations & Difficult … difficult tutoring...Handling Difficult Tutoring Situations & Difficult ... Handling Difficult Tutoring Situations & Difficult

A virus can be difficult to overcome. A virus has the ability to mutate or change slightly in each infected person, making it hard to treat. Some noted

SPOT90measures Japanese language proficiency. The sentences/phrases may seem slightly difficult to hear or the response time too short, but if the examinee has sufficient proficiency,

One Nation, Slightly Divisible. - RIC

Changing Human Behavior is One of the Most Difficult Tasks of Water Conservation 1