Help and help again

I based my application for the Outreach Program on a DocBook to Mallard port of the Vinagre help.. suffice to say, it wasn’t that great. So, I have now fixed it up, with some pointers from Shaun, to be more topic-oriented and less *ahem* technical.

I have since started working on Brasero. This time, I have an advantage of starting with some notes for what should be included in the help, which were written up at the Open Help Conference brainstorming sprint. While writing instructions on how to use the application is not particularly challenging, I am finding that writing in a way which is “not technical” and understandable by users who would look at the help quite difficult, because terms which I take for granted are often misunderstood or not known by the audience I should be aiming at.. which is probably not anyone reading this blog. But the biggest problem I have come across is that Brasero could do with some love and care. I won’t count the number of ways of making it crash that I have managed to find, but with 229 open bugs, it is in need of some maintenance.

I have not been able to find a good guide on the style of the writing needed for user help, so I have been using the Empathy help as an example, with Shaun giving me feedback as I go along.

Leave a Reply

Your email address will not be published. Required fields are marked *
https://blogs.gnome.org/kittykat/2011/07/17/help-and-help-again/
blogs.gnome.org
crawl=CC-MAIN-2019-39
25029
application/http; msgtype=response
sha1:EHAM3XX3DBZU4MNT6XCM5PSVG27NQ6GE
<urn:uuid:fa5d3d41-579a-440c-97a9-7afabf9cd7b8>
2019-09-23T09:08:22Z
8.43.85.14
text/html
sha1:OMTWBPBYEGSPJZU25LUYBPTOEXKL2V6Z
<urn:uuid:785346fd-49f3-4211-b4da-42e030c3b601>
https://blogs.gnome.org/kittykat/2011/07/17/help-and-help-again/
response
<urn:uuid:46e1d787-b475-4f2e-8257-09f9535702f2>
isPartOf: CC-MAIN-2019-39
publisher: Common Crawl
description: Wide crawl of the web for September 2019
operator: Common Crawl Admin (info@commoncrawl.org)
hostname: ip-10-67-67-108.ec2.internal
software: Apache Nutch 1.15 (modified, https://github.com/commoncrawl/nutch/)
robots: checked via crawler-commons 1.1-SNAPSHOT (https://github.com/crawler-commons/crawler-commons)
format: WARC File Format 1.1
conformsTo: http://iipc.github.io/warc-specifications/specifications/warc-format/warc-1.1/