Generating a Culture of Doc

A session at Write the Docs

Monday 8th April, 2013

1:20pm to 2:00pm

How do you encourage engineers to do the write thing? (Not a typo.)

At Salesforce.com, we now have a team called, “Core Documentation.” We are primarily focused on documenting our internal systems and architecture. Many of us on the team don’t create content: We generate framework, best practices, and training for engineer-created content. (Content can include and is not limited to: code comments, run lists, specs, team web pages, wikis, white papers, architectural diagrams, presentations, etc.)

But that goes back to the first question–how do you get someone to write, when the word “writer” isn’t part of their title?

We’ve been successful using several different venues: - Documentation “hack” day – where engineers spend a day improving their internal doc - Events where posters of different aspects of the architecture are displayed (think art walk, only for engineers) - VERY easy to use templates for readme files, etc. - Lunch meetings/presentations/training/networking - Flattery, appeals to logic (bus factor) and bribes

Plus I would also present some of the things that haven’t worked.

About the speaker

This person is speaking at this event.
Leah Cutter

I write fantasy, mystery, science fiction, and horror. Currently indie-publishing it all as well. bio from Twitter

Coverage of this session

Sign in to add slides, notes or videos to this session

Tell your friends!

When

Time 1:20pm2:00pm PST

Date Mon 8th April 2013

Short URL

lanyrd.com/scfpdc

View the schedule

Share

See something wrong?

Report an issue with this session