Write the Docs EU 2014 is now over. Attending this conference has been a great opportunity to discover a new community: technical writers and documentarians.
This blog post is a personal understanding of the actual state of documenting software projects. The Python community, Read the Docs and GitHub are playing an essential role in the evolution of this (f)actual state.
§State of the Documentation
Which is great at some point because Write the Docs has been a good excuse for me to have a fresh look on a rising community within the software industry.
This is somewhat strange to discover the job of technical writers, just now, in 2014.
I naturally thought the technical documentation was under the responsibility of developers. And that the end-user documentation was a joint work with the marketing team.
Still, the documentation is not yet a first class citizen in projects. In term of design, maintenance and eventually language availability. For what I have seen and understood, it was the case only in big IT organisations such as Red Hat, Apache or the BBC.
reStructuredText, Sphinx and Read the Docs is a good combination to write, publish and maintain documentation at a large scale with a minimalistic hassle.
To quote Sebastien Goasguen, Read the Docs is nice at least for the edit on GitHub link. It helped dramatically to increase external contribution and thus to raise the documentation quality.
The community was mostly Python focused. This might be a bias from the previous point though.
I would like to see more of the work from other programming language communities to learn more about their way of handling documentation.
When it is related to translation, it seems that Transifex is the best available collaborative translation tool. It is free for Open Source projects, paid otherwise.
Even though the translation memories comes only with Enterprise plans.
§Maintaining a Documentation is a Real Work
Write the Docs has been a good event to teach me the following things:
- documenting can be a full time job;
- how to have a single documentation targeting product variations;
- how to address the extra level of complexity of translations.
I have been a bit shocked by the number of times I heard that developers simply do not want to write documentation because it is not part of their job (sic). I also remember back in the days, writing the documentation was the last minute job we would take care about, because it was not rewarding and painful to do.
One the main excuse is that coding is more important than communicating. Whereas today I would favour hiring someone more incline to communicate rather than aiming at code excellence.
Welcome to the documentarians world!
I never realised the complexity induced by having multiple flavours of a software. Like an Open Source version and a commercial version. Two approaches have been discussed:
- the delta approach; by applying to Product B the content delta of Product A documentation (maintaining a delta between B and A is too difficult);
- the content variant approach; by using content variables and conditional blocks to display the right content for the right product.
Atlassian Confluence seems to provide a pretty neat way to address that.
I also discovered two difficulties for translations.
The first one relates to the translation capacity: how do you deal with the documentation and software translation for a region of the world you do not have any knowledge?
You pay for the translation but and most essentially, you need to enable contributions. This way users do not complain but rather help and fix the mistakes.
Another area where making people responsible improves the working conditions.
And finally, translating is a thing, but enabling the translation is another one. The translation tool should enable the translation of software and documentation strings as well as injecting them again in the source code, monitoring the progress and .
Transifex seems to be the leader in this domain.
§Towards Collaborative Documentations
Enabling collaboration improves quality and adds a new dynamic. At least two projects shared that learning.
Sebastien Goasguen shared the CloudStack documentation migration process. How they moved from Docbook and Publican to reStructuredText and Read the Docs.
Pandoc has been very helpful, and GitHub is playing an essential role in the collaboration bit.
Finlan Bolton explained the state of collaborative documentation at Red Hat. They managed to reach a thousand contributed pages among 6,000. This is quite a big deal!
Again, lowering the entry barrier, being inclusive and tolerant with contributions helped them improving the completeness and quality of their documentation.
§GitHub Already Changed the World
GitHub has made a huge impact in the software development world. I cannot count how many things are now built on top of GitHub.
The GitHub platform has been quoted in almost half of the talks. Because of the code hosting. Because of the way to collaborate on content. Because of GitHub Pages.
Because they have made a super easy system to make things working without the hassle of previous platforms.
They have been fast at adding features and lowering the entry barriers between our code and the Internet.
There is no doubt if something takes over git, they will follow and keep the workflow as easy as possible.
On the other hand, I would not call GitHub a free product anymore: if GitHub disappears, this would create a gigantic black hole in the Internet (and so many people to comfort). Even if we have a copy of our git repos on our hard drive.
§My Talk: README Driven Development
I have been pleased to perform my first public speaking outside of France and UK: README Driven Development. Bryan Villarin from Automattic wrote a live summary of it. A video should be available sometime in the future.
It is a complete rewrite of a talk initially performed at Paris Web in 2012. There are a lot of additions:
- storytelling: Steph Troeth Sud Web’s 2013 workshop and working at the BBC have been a huge kick forward that content delivery form. And it worked!
- driving a project through a README by writing it from day 1;
- driving contributions by using the same mechanism, by providing a vision among issues and pull requests.
As a summary, I encouraged people to trust their guts, to accept shallow limits and to clear things out by talking together (at the coffee machine) rather than by increasing the length of an already-too-long document.
§What is Next?
The conference gave the will the resurrect my JSDoc to Markdown project. I hope to have an interesting Asciidoc to Open Office workflow to share as well… and maybe some associated tools to write a book without opening neither Word nor LibreOffice.
Many interesting discussions sparked about including documentation as a quality metric, as an indicator of job done and as a way to be automatically generated through commits, pull requests and why not as a linter you could apply as part of your CI process.
Something lighter than SDL Authoring Assistant and more in the spirit of eslint. But for commits/pull requests/documentation files.
And in 2015 or 2016, why not organising Write the Docs Europe in the beautiful BBC Radio Theatre?