Just Write Click

Technical writing with Continuous Integration and docs-as-code

  • JustWriteClick
  • Contact
  • Books by Anne Gentle
  • Introducing Docs Like Code
You are here: Home / Uncategorized / BookSprint – results!

September 1, 2008 by annegentle

BookSprint – results!

BookSprint – results!

What a week it was. I’m tired but very proud of what we accomplished.

We wrote seven manuals for One Laptop per Child in a week: one for Sugar, the operating system, one the XO, which is the hardware for all of the deployments for One Laptop per Child, and manuals for five Activities: Browse, Terminal, Write, Chat, and Record. I think our PDF page count is over 200 pages!

Cover pages from the seven manuals we completed.

Results – the XO Manual is available (56 pages) and the Sugar Manual is available (132 pages). While the XO manual still has some missing images (screenshots and such), and I’d like to keep expanding the “Beyond Activities” chapter in the Sugar manual, we met the goals of the Sprint. Documentation never feels “done,” does it? Updated to add: the images are in the networking chapter of the XO manual, yuh!

Here’s how the week went. Sunday afternoon, we met at my employers for about 2-3 hours to plan out the outlines for all the books and make sure the scope was appropriate for the writers we had. I had an online discussion the prior week on the OLPC Library list, where content is discussed, to get buy-in from the community on the scope of the books and the audience for the books. By focusing the audience, we helped set scope, and by asking questions about scope and getting feedback, we could further narrow down the outlines for the manuals.

Sunday night we had a nice social event with the XO Austin user’s group at Mozart’s coffee house and finished up the night at Hula Hut for a nice dinner and drinks discussion. This type of informal socializing helped us get to know each other.

In a great conference room at Motive on Monday, Tuesday, and Wednesday we wrote all day, as if it were a work day. Tuesday night we had a cookout at the hotel. We intended to have some more rest and relaxation Wednesday afternoon, but then decided to push it to the evening to keep the writing momentum going forward, but we all were tired enough to opt out of a 10 o’clock movie at the Alamo Draft House.

Thursday was spent as if we were in the last lap of the sprint, writing and finishing furiously, and Friday we spent doing cleanup in order to create all seven PDFs by the end of the day.

I’ll have a lot more to say about the BookSprint in the coming weeks and months, because I believe in this model for free documentation and I am so in awe of FLOSS Manual’s wiki toolset and remix capabilities. Updated to add: thanks to Adam Hyde, Aleksandar Erkalovic (aco), who was updating while we sprinted, and Lotte Meijer, who made the awesome covers for the manuals. Your group makes up an amazing team.

In the meantime, enjoy some of my favorite pictures from the event.

Adam quite happy with the resulting PDF printouts
Walter Bender of Sugar Labs, and Adam of FLOSS Manuals writing the day away
FLOSS Manuals' wiki interface even works in the Browse Activity on an XO laptop as shown in this screenshot!

What’s next? As the maintainer of the doc set in FLOSS Manuals, I’m monitoring notifications on every manual we worked on. I want to continue accepting documentation requests through the Comment system on each chapter of the manuals in FLOSS Manuals. I hope that the participants will continue to feel ownership and make updates as they see fit. We’re hoping to translate both the content and the FLOSS Manuals interface to Spanish to assist in and create efficiencies for Spanish translation of the content.

There are so many thank yous and acknowledgments for the hard work this week – I hope I have adequately personally thanked all who participated in the planning leading up to the sprint as well as the many people who participated in the sprint itself. I’m bursting with pride in the community effort here and hoping to keep the momentum going in an even, sustainable pace. For the next few weeks I need to get my energy back from such a “sprint” effort, but I’m very proud of our results.

Related

Filed Under: Uncategorized

More reading

Bubble graph showing sources of developer support data

I’ve been thinking a lot about developer support at Cisco recently, especially for the way the world works today with multiple cloud providers. This post is a re-publish of my talk from over five years ago, but the techniques and tools for listening and helping others are still true today. At Rackspace, we watched several […]

Cisco DevNet is our developer program for outreach, education, and tools for developers at Cisco. From the beginning, the team has had a vision for how to run a developer program. Customers are first, and the team implements what Cisco customers need for automation, configuration, and deployment of our various offerings. Plus, the DevNet team […]

I had a great talk with Ellis Pratt of Cherryleaf Technical Writing consulting last week. Here are the show notes, full of links to all the topics we covered. Podcasts are great fun to listen to and participate in, if a bit nerve-wracking to think on your feet and make sure you answer questions succinctly […]

At the beginning of this year, I worked hard to summarize my thoughts on API documentation, continuous publishing, and technical accuracy for developer documentation. The result is an article on InfoQ.com, edited by Deepak Nadig, who also was forward-thinking in having me speak to a few teams at Intuit about API documentation coupled with code. Always […]

Recently on Just Write Click

  • A Flight of Static Site Generators: Sampling the Best for Documentation
  • Try a GPT about “Docs Like Code” to ask questions
  • Discipline and Diplomacy: Docs in the Open
  • Let’s Find Out: When Do Static Site Generators Do Rendering?
  • GitHub for Managing Tech Docs

Just Write Click in your Inbox

Enter your email address to subscribe to Just Write Click and receive notifications of new posts by email.

Read More

  • Privacy Policy
  • About Anne Gentle, developer experience expert
  • Books by Anne Gentle
    • Conversation and Community
    • Docs Like Code, a Book for Developers and Tech Writers
  • Woman in Tech Speaker Profile
  • Contact

Books

  • JustWriteClick
  • Contact
  • Books by Anne Gentle
  • Introducing Docs Like Code

Copyright © 2025 · WordPress · Log in