ITauthor Podcast

ITauthor Podcast 39 - Three levels of HelpGraham Campbell and I met up after work for a pint and a chat in The Oxford Bar. For those of you who haven't had the pleasure, The Oxford Bar is a tiny little two-room pub in the New Town of Edinburgh which first became a pub back in 1811. More recently it has become well known through mentions in Ian Rankin's Rebus novels. The evening we met there was a very smoky coal fire burning and, as I mention in the recording, we came away from there with clothes stinking of coal smoke. This is the reason you can hear quite a lot of coughing in the background, although we both managed to get through the podcast without spluttering or gasping for breath. We were in the side room, which filled up while we were there, so there's a lot of background noise. It actually sounds like we're in a big place with lots and lots of people – we weren't: we were in a small room with just a few other people. I hope you are able to make out what we're saying amid all the background chat. I was recording this using an iPod Nano and an iPhone and I'm actually quite amazed the recording turned out as well as it did.In this podcast: - Graham discusses the 3 levels of user assistance he's implementing for a project he's working on: 1) "Guide me", 2) "Read more", 3) Guided tours using Bootstrap Tour - I scratch the surface of the subject of translating software documentation. Managing documentation translation is a whole career in itself, so I really only touch on this and mention just a few of the issues I've faced working on this over the past few months. These include: allowing plenty of time, supplying the translators with a glossary, and figuring out how you're going to verify the translation. - We both chunter on about about attempting (as British technical writers) to write in US English. We agree that, even if you remember to drop the Us in words like colour, and to use a single L in words like canceled, and when there's punctuation immediately after a quotation to put it inside the closing quote mark, you're unlikely to prevent a US reader realising that your documentation has not been written by a native writer of US English.Recommendations Graham: The Art of Explanation by Lee LeFever Alistair: REAPER audio editing application-------------------------- The intro/exit music is by Amplifico. You can hear more of their music at musicalley.com: http://tinyurl.com/amplifico --------------------------If you'd like to get in touch with me about anything you hear on the podcast, drop me an email at: comments@itauthor.comAlternatively, you can post a comment on my website by going to www.itauthor.com/podcastarchive, clicking the link to this show and using the comment form at the bottom of the page.Thanks for listening Alistair Christie=======================The ITauthor Podcast is a series of audio recordings of no set length, published to no set schedule. The content is generally, but not exclusively, focused on technical writing and, specifically, issues involved in the business of documenting software. The podcast is not sponsored, endorsed or supported by any organization. I put this podcast together in my own time and, while I try to make the audio quality listenable, I make no promise that the content will always be of any particular quality. But, if you're interested in documentation and software I hope you'll find something interesting in here.All views expressed in these podcasts are entirely the personal opinions of the individual speakers, come with no assurance of veracity, are not sanctioned or endorsed by any third party, are not made on behalf of any organization the speaker is or has been connected with, and do not reflect the views of the speaker's employer.The audio recordings and accompanying text and images that make up this podcast are available to share and/or remix under the conditions of the Creative Commons Attribution-NonCommercial-ShareAlike 3.0 Unported license (CC BY-NC-SA 3.0). See: http://creativecommons.org/licenses/by-nc-sa/3.0/

ITauthor Podcast 38 - Documenting IT ArchitectureAndy Tucker is Head of IT Strategy and Architecture at DWP, and an old friend. I asked him to explain what "architecture" is in the context of computer systems and software. He also talks about the importance of documentation and the types of documentation used by systems architects.-------------------------- The intro/exit music is by Amplifico. You can hear more of their music at musicalley.com: http://tinyurl.com/amplifico --------------------------If you'd like to get in touch with me about anything you hear on the podcast, drop me an email at: comments@itauthor.comAlternatively, you can post a comment on my website by going to www.itauthor.com/podcastarchive, clicking the link to this show and using the comment form at the bottom of the page.Thanks for listening Alistair Christie=======================The ITauthor Podcast is a series of audio recordings of no set length, published to no set schedule. The content is generally, but not exclusively, focused on technical writing and, specifically, issues involved in the business of documenting software. The podcast is not sponsored, endorsed or supported by any organization. I put this podcast together in my own time and, while I try to make the audio quality listenable, I make no promise that the content will always be of any particular quality. But, if you're interested in documentation and software I hope you'll find something interesting in here.All views expressed in these podcasts are entirely the personal opinions of the individual speakers, come with no assurance of veracity, are not sanctioned or endorsed by any third party, are not made on behalf of any organization the speaker is or has been connected with, and do not reflect the views of the speaker's employer.The audio recordings and accompanying text and images that make up this podcast are available to share and/or remix under the conditions of the Creative Commons Attribution-NonCommercial-ShareAlike 3.0 Unported license (CC BY-NC-SA 3.0). See: http://creativecommons.org/licenses/by-nc-sa/3.0/

ITauthor Podcast 37 - Return of the PodcastI met up with Graham Campbell the other day for a beer and his enthusiasm for his new job made me think it was about time to dust off the microphone, fire up Skype and record another episode of the ITauthor Podcast.So in this episode Graham talks about his time in the South of France and compares that to his new job back in Scotland. Previously he found working for a large company with a rigid style guide and way of working was a bit of a straitjacket and sometimes prevented him from communicating information in the most effective way. Now, working as the sole technical author again, he enjoys being able to input his ideas about design and usability.Recommendations Graham: The musical one-of-a-kind that is Ronald Jenkees - http://www.ronaldjenkees.com/ Alistair: Podcast interview with Mark Baker where he explains his concept of "Every page is page one" - http://idratherbewriting.com/2012/12/11/podcast-include-it-all-filter-it-afterwards-interview-with-mark-baker/-------------------------- The intro/exit music is by Amplifico. You can hear more of their music at musicalley.com: http://tinyurl.com/amplifico --------------------------If you'd like to get in touch with me about anything you've heard on the podcast, drop me an email at: comments@itauthor.comAlternatively, you can post a comment on my website: - Go to www.itauthor.com/podcastarchive. - Click the link to this show. - The comment form is at the bottom of the page.Thanks for listening Alistair Christie==========================The ITauthor Podcast is a series of audio recordings of no set length, published to no set schedule. The content is generally, but not exclusively, focused on technical writing and, specifically, issues involved in the business of documenting software. The podcast is not sponsored, endorsed or supported by any organization. I put this podcast together in my own time and, while I try to make the audio quality listenable, I make no promise that the content will always be of any particular quality. But, if you're interested in documentation and software I hope you'll find something interesting in here.All views expressed in these podcasts are entirely the personal opinions of the individual speakers, come with no assurance of veracity, are not sanctioned or endorsed by any third party, are not made on behalf of any organization the speaker is or has been connected with, and do not reflect the views of the speaker's employer.The audio recordings and accompanying text and images that make up this podcast are available to share and/or remix under the conditions of the Creative Commons Attribution-NonCommercial-ShareAlike 3.0 Unported license (CC BY-NC-SA 3.0). See: http://creativecommons.org/licenses/by-nc-sa/3.0/