Reading time: 8 minutes
Presented at Write The Docs - Sydney [slides]
My story starts at the international conference for Free and Open Source Software for Geospatial when it was held here in Sydney, ten years ago. We wanted to build a distribution of the software to hand out to conference attendees. Back then when software was expensive to download, it was a useful handout, and it provided an attractive marketing pipeline for these free software projects.
To build the first version of OSGeoLive we followed install instructions, configured applications, resolved dependencies and conflicts, asked questions on email lists, and finally, after much hard work, produced our first release. This was a very important first step as it showed that we had the commitment to follow through and deliver.
But our first calls for help were embarrassingly underwhelming. You see, the perceived learning curve for packaging was considered unacceptably high and volunteers were not stepping up.
To fix this, we wrote an example install script along with clear, step-by-step instructions. We then went back to developers with the message of "if you can spend a couple of hours writing a short install script which looks like this, then we will market your application through our OSGeoLive distribution". Small effort / High Value. And it worked! 28 projects packaged their applications for our version 2 release.
|Using a document template|
Translators later adopted the same formula to create multiple language variants.
Unpacking the storyOk, let’s unpack this story from the perspective of technical writers. Firstly, we should acknowledge the significant efficiencies software enables. Four out of the ten richest people in the world are self-made software entrepreneurs.
However, while proprietary businesses centralise captured wealth, open source software, like other creative commons works, is given away for free. This act of sharing has far-reaching consequences. Tools and knowledge created can be used and built upon by everyone. This democratises knowledge, wealth and power.
So if you want to positively improve our world, supporting Open Source projects is a good place to start.
The ResearchSo what makes a successful Open Source project; one which is sustained in the long term? Research provides some answers, An analysis of over 170,000 Open Source projects to identify success factors, and a study of the success factors of episodic volunteering in Open Source both highlight the importance of:
- Clear utility,
- Lean governance,
- Clear vision and goals,
- Marketing and a quality website,
- Good user and developer documentation,
- Digestible information,
- Guided introductions,
- Simple workspaces,
- Task–finding dashboards,
- Financial backing,
- Fine-scaled task granularity, making it easier for people to contribute.
- Leaders who lead by doing, by putting in the hard work,
- A virtuous and supportive community,
- Attracting external contributors,
- Advocating broadly, by all involved,
- A sense of collective ownership,
- Hosting of meetups,
- Recognising all forms of contribution,
- Personal invitations for help,
- Showing appreciation.
|Communicators helping the world|
- Making the world more egalitarian,
- Reducing wealth inequality,
- And democratising knowledge and power.
Bridging the tech gapI’d like to touch on inflection points. As a project’s technology and user base matures, community success factors move. An early inflection point with Open Source projects happens when a project attracts external contributors. These contributors increase the size of the workforce and add extra skills, but they lack the deep domain expertise of the core team.
To attract contributors, projects should reduce ramp-up time; and good documentation is key. Poetically, the documenters who are most qualified to help are typically the least technical, and face the greatest ramp-up time.
Johanna reviewed an early draft of this presentation and observed that ...
Some of the issues relating to getting started are about bridging the gap between developers and writers. Developers write code in coding tools. They collaborate, they are used to versioning and are at home with unformatted raw text and automation tools. Writers? They work on Windows machines in Word – maybe in Google Docs if they are lucky. They don’t know about running build scripts, running Linux variants, Github, chat programs, HTML, RST, Wikis and the variants of markup languages.It’s one thing to work with the Open Source software, another to write about it, and a third thing to work out how to write it so that it fits in with the project. It seems as if the developers have created the writing system in a way that they are used to working, not necessarily in a way that works for writers.
And I think Johanna is right. I’ve found many users and writers who are keen to help but feel overwhelmed, don’t know where to start, don’t want to burden the existing community, and so are shy to ask questions.
Writers need to be sought out, welcomed, encouraged, supported and publicly appreciated if projects are to attract good documenters to help them grow.
In turn, I’d encourage writers to proactively reach out to development communities. I’d expect you’ll find them very welcoming and appreciative, especially if you are volunteering to tackle key documentation pain points. And together we need to help bridge the gap between writers and developers.
Documentation StrategySo what should writers expect to see when joining a project. Typically, emerging projects have patchy documentation, in various stages of currency, completion, relevance, verbosity, and quality. The challenge is to consolidate it so that it becomes concise, intuitive, accurate, minimises learning and ramp up time, and sustainably maintained to match continually evolving software releases. This is non-trivial and requires good writing skills, planning, leadership, commitment and follow through to do it well.
The problems are that:
- Software is complex. It’s hard to understand, and harder to explain.
- Software continually evolves, meaning documentation needs to be continually maintained.
- Projects have a range of audiences, with differing information needs, technical backgrounds, and attention spans.
|Document structures recommended in What nobody tells you about documentation.|
There is a secret that needs to be understood in order to write good software documentation: there isn’t one thing called documentation, there are four. They are:Daniele is on the right track although I feel his list should be expanded to include other forums.
They represent four different purposes or functions, and require four different approaches to their creation. Understanding the implications of this will help improve most software documentation - often immensely.
- How-to guides,
- Explanations and
- Technical references.
|Placing documentation types|
Raw image (in draw.io format)
Writers should identify and define the characteristics of their communication mediums.
The front web page and elevator pitch should be concise, highly polished and target first-time visitors, while community forums are good for once off questions and can be rough around the edges.
For each medium, define:
- Target audience,
- Document structure,
- Technical depth,
- Quality requirements, and
- Maintenance strategy.
- Write timeless material to minimise maintenance.
- Only write as much as your team has the capacity to maintain.
- Help techies become great writers. Provide skeleton docs and writing instructions, then review, mentor and publish.
- Work within a release cycle, which ideally synchronises with the project.
|Tech Writer Heros|
- Focus on one project instead of many, as your ramp-up time will likely be high.
- Acknowledge the value you bring. Use it as motivation because you’ll have many challenges and the inner motivation will really help.
- Demonstrate commitment. It’s contagious.
- Ask for help, you will need it, and you’ll likely be surprised how supportive people will be.
- Don’t be daunted by your lack of domain knowledge. It’s actually an asset when writing to a broad audience.
- Help developers become great writers. Great impact comes from amplifying the effectiveness of others.
- Be part of the team; help paint the vision; be inspirational.
- And most of all, have fun while you are doing it. Because believe you me, it is hugely rewarding to share the team camaraderie involved in building something that is much bigger and more impactful than you could possibly create by yourself.