Write the Docs Australia: 2 years and counting…

Standard

This Friday, 20th July 2018 marks Write the Docs Australia’s second birthday.

Last year, when I documented A year of documentation goodness I had a fair idea of how I wanted to contribute to and build this community. I am amazed at how the community has grown over the last two years and the friendships and opportunities it has provided to a very diverse group of people who care about and are passionate about documentation.

I hope it has benefitted the community as much as it has to me in terms of personal growth, knowledge sharing, learning, and networking.

Challenges

Organising the community meetup events and the conference has been one of the most challenging roles outside of work. I have learnt a lot about building and growing a community, finding speakers and convincing them to speak, promoting the community, and organising the logistics of the event.

Russell Dickenson and Brice Fallon-Freeman (Brisbane), Sarah Maddox and Michalina Ziemba (Sydney), Nicola Nye (Melbourne), Leticia Mooney (Adelaide) and Shauna McGee Kinney (Perth) have been a huge support in helping me start, organise and keeping the city-specific events running smoothly.

In order for this community to grow organically, it is important for members to support us by attending, volunteering, take every opportunity to speak and share their knowledge and promoting the community within their organisations. Documentation is critical to any role, product, system, process and this community provide a good environment to nurture this passion and add to your skills and professional networks.

Membership stats

Speaking of members, the Write the Docs Australia membership now stands at 479 and while not all of them are regular attendees, we’ve certainly established a steady credence of attendees and volunteers for our events. Luckily, the varied nature of our talks has encouraged a range of people to attend, depending on the presentation topic, which has always brought about different perspectives, ideas, and questions.

Here is some data provided by Meetup.com:

WTD_Joins

Member joins

WTD_Going

Active/passive participation

Slack channel

The Australian WTD slack community has close to 97 members.

In the same time range, the Write the Docs slack community now stands at 4186 (was 2206 same time last year).

Write the Docs Australia events

We’ve certainly had a very busy 12 months with 15 events across Australia:

  • 4 in Brisbane
  • 3 in Melbourne
  • 3 in Sydney,
  • 2 remote sessions,
  • 1 each in Adelaide and Perth and
  • The first one-day mini-conference/event (Add Sarah Maddox’s blog link)
  • Collaborated with Young Coders AU and Justin Cheong to hold a Draw+Code+Write workshop for kids. It was very well received and we hope to do this again.

A big thank you to all the speakers who volunteered and readily presented and participated in our events.

All things documentation

  • We talked about Content Strategy, Design errors, UX documentation, working with chatbots, SVG for tech writers, history of Australian games industry, minimalism in documentation, developers documentation, imposter syndrome, Information Architecture, Q&A around tech writing teams and hiring, contributing to open source docs, moving docs from word to web, ethics and documentation, doc fix-its, API documentation and knowledge management.
    From a pure attendee viewpoint, there is just so much documentation goodness people are willing to share and so much to learn if you are documenting in any aspect of your role.
  • We had 2 remote sessions: a lunchtime session on docs-like-code presented by @Anne Gentle all the way from the US and another Australia-wide one featuring 5 lightning talks and 2 presentations on release notes and devrel from members all across Australia.
  • We had founders, writers, content strategists, graduate students, developers, UXers, QA, product owners and engineers attend, network, speak and share their experiences.
  • We had ongoing support from companies like Atlassian, General Assembly, Red Hat, and BigWorld/Wargaming who hosted our events and sponsored food/drinks generously.

All of these events have been undertaken by volunteers on their own time and in addition to their busy schedules, so a huge shoutout to everyone involved in keeping the community going.

This slideshow requires JavaScript.

What’s coming up in 2018?

The first full 2-day Write the Docs Australia conference takes place in Melbourne on 15 and 16 November and we hope to make it a regular feature on the Australian tech/ documentation as well as the Write the Docs conferences calendar.

Before the conference, we will have another round of meetup events across

There is a possibility of another WTD event (in collaboration with UX and CS communities) in Adelaide.

We will round up the year with another remote session (details to be confirmed) in December.

Advertisements

Create, work with or curious about documentation? You don’t want to miss this!

Standard

It was 2005 when I enrolled in the Graduate Diploma of Technical Communications course at Swinburne. Documentation (especially the part where you create it) had been around for years before that, but yet somehow, it was still getting treated like a secondary citizen.

I learnt so many amazing things with the Grad Dip and by the time the course had finished, I had secured my first gig as a Technical Writer. I met so many wonderful people at and outside Uni who were passionate about documentation.

As a newbie tech writer, it was crucial for me to meet other people in similar positions so that we could share experiences and learn from each other. I wanted to be a part of the technical writing community, just sit and absorb all that knowledge out there. I wanted to work with companies where documentation was valued and the company took pride in this aspect of the customer experience.

About 5 years back, I got an opportunity to participate in a documentation sprint. Working with a team of developers, product owners and other writers over a period of 3 days to create documentation for users. This was not for a company I worked for. This wasn’t even in the city I lived in. I travelled 2 consecutive days (self-funded) to spend 8-10 hours learning the product, playing around with it, troubleshooting it and documenting it for their users. It was perhaps the most exciting thing I did at that point in my career. Read my experiences here.

11 years later, I have worked through a number of permanent and contract roles across a range of industries and know what still bothers me? The lack of understanding around the role documentation plays in the whole customer experience.

For many companies I worked for, I was the first technical writer and they had no idea of what to expect in terms of documentation. For a number of big organisations, the role documentation played was minuscule and not that significant. There were only a handful of places I worked where the people that mattered got it. They understood how providing good documentation, be it internal or external, made a huge difference to their reputation, to their user satisfaction and even within the organisation. These were places where the culture brewed right out of a user guide, wikis, knowledge bases, and a system of good documentation habits.

As technology proliferates and customer and user experience drives businesses to come up with better, faster and efficient products, documentation is the thread that binds everything together.

Why am I rambling on about this?

Over the last 15 months, I’ve been working to get a community of documentarians (that’s what we call ourselves) going in Australia. Write the Docs is a worldwide community of documentarians and they are growing in numbers exponentially. In Australia, we have had around 13 events so far across Melbourne, Sydney, Brisbane and Adelaide. But that’s only half the story.

We have a whole day of documentation goodness coming to Melbourne on 24th Nov (Friday).

You want to participate in a live documentation sprint and contribute to open source projects at Google? We’ve got that covered.

You want to hear about how chatbots UIs will influence writers or writing documentation that meets the requirements for all levels of users. We’ve got speakers from overseas sharing their views.

Feel overwhelmed before writing and want to know how to make use of all that information, or want to know how to supercharge your docs, or maybe try to use the principles of minimalism in your docs? We’ve got some great speakers helping you out there.

I would have given my right arm to participate in something like this when I started out as a technical writer. The good thing is it won’t cost you that. You can buy tickets now and enjoy all of this at a price you would normally spend on an airport shuttle to get you to the city and back.

Here’s the schedule: http://www.writethedocs.org/conf/au/2017/schedule/

Here’s the link to buy tickets: http://www.writethedocs.org/conf/au/2017/tickets/

Over to you. Go.

A year of documentation goodness

Standard

Today marks the 1 year anniversary of the Write the Docs Australia community. We’ve come a long way and have even a longer way to go yet. 300+ members and counting.

A big thanks to everyone who has made this possible – attendees, speakers and hosts.

Where it all began…

To me personally, Australia seemed to have fallen behind in organising meetups, conferences or any events around documentation. We don’t even have any university level programs teaching the basics of documentation. There is an ever increasing demand on creating clear, consistent and useful documentation and we just didn’t seem to be doing enough to address it.

I came across the Write the Docs community when I was looking for a group to network, a place to belong and a tribe to identify with. Having heard of the Write the Docs Prague conference, I put in a presentation proposal which was accepted and I was on my way to the Czech Republic.
When I first signed up to the Write the Docs Slack channel, there were just about 700 people in the #general channel, and just about a dozen in the #australia one. (For reference, they now stand at 2206 and 67).

Here was a community that had its roots in developer/software docs, but had expanded over the years to include anyone who created, appreciated and understood the value of documentation.

Sometimes, as they say, the best way to be involved is to start something. So, I initiated the Write the Docs Australia meetup group on July 20, 2016.

Looking back over the last 12 months, it has certainly been an exciting ride.

Tribe of documentarians

Anyone who cares about the quality of documentation and its impact on the users is someone we think of as a documentarian.

Over the last 12 months, we have had 7 events across Australia. 2 in Brisbane and Melbourne, and 3 in Sydney. The Adelaide one is not far away.

With a little help from the wonderful Content Strategy and User Experience friends, we are headed to Write the Docs Adelaide on 7th Aug.

The very idea of having an inclusive, vibrant community of people who create documentation as part of their roles drove us to talk about all things documentation.

  • We talked about APIs, Interacting with Developers, Roles in Product teams, Visual documentation, Analytics, Doc-a-thons, Localisation, Markdowns, Storyboarding, Data, Product Development docs and more.
  • We had writers, developers, UXers, QA, Product owners and Engineers attend, network, speak and share their experiences.
  • We got some solid support from companies like Google, Atlassian, Campaign Monitor, General Assembly, Red Hat, and River City Labs who hosted our events and sponsored food/drinks generously.
  • We streamed most events live and almost all recordings are available on the Write the Docs Australia Youtube channel

This slideshow requires JavaScript.

What’s coming?

The first ever Write the Docs Adelaide takes place on Monday, 7th Aug. We are already planning for events across Brisbane, Melbourne, and Sydney in Aug and September.

A 1-day mini conference sometime late November is already beginning to sound like a possibility.

A very wise person (Eric Holscher) once said:

Write the Docs meetups, now in Australia!

Standard

At the start of 2016, through various sources, I discovered the Write the Docs community. Best thing that happened in my professional life. I was vaguely aware of the Write the Docs movement (and that is what it is), I decided to get involved because I was getting disillusioned by the other tech writing body I have been working with (the ASTC) for a number of years. I knew a few Australian based writers who were already a part of this community and their feedback was encouraging.

“Write the Docs is a series of conference and meetups focussed on all things related to software documentation”, is how the website describes it, but I suspect it has matured beyond software documentation. It is a rapidly growing community of anyone associated with, or involved with documentation, be it developers, customer support, technical writers or product managers.

While the Write the Docs has 2 conferences every year, one in Portland, Oregon (US) and the other in Europe (various locations), the community is also supported via a number of meetups hosted across a number of cities in US and Europe. It was time to get the Write the Docs to Australia. Our first Aussie WTD meetup took place in Melbourne on 9th Sept 2016.

Write the Docs Melbourne Sept 2016

The ever affable and enthusiastic Sarah Maddox accepted my invitation to speak at our first meetup and even flew down from Sydney specially for this. Thank you Sarah!

In her presentation, Sarah gave us the low-down on how to work with engineers to create, collaborate and produce API documentation. She stressed the importance of getting to know the engineers, their interests and participating in work activities such as hackathons with engineers.

During Sarah’s talk, she got the meetup attendees to live collaborate on a document she had shared before her presentation. At the conclusion of the talk, she discussed the comments from the live documentation. This was a way to demonstrate how tech writers and engineers collaborate on content.

WTD

After her talk, I gave the attendees a preview of my conference presentation on “When bad screenshots happen to good writers”. It was well received and I got some good tips and feedback on the presentation material.

The WTD Melbourne meetup has now over a 100 members who have signed up in a space of 6 weeks; members across a variety of professions and backgrounds, interested in the art of documentation.

What next?

Got an idea for a presentation? Know someone who is keen on sharing their knowledge of awesome documentation techniques? Have a burning documentation issue you need to address with fellow documentarians?

Get in touch with me through the WTD Melbourne meetup page and we can schedule something.

ASTC Event: Managing your personal brand

Standard

I attended the local Victorian event organised by ASTC (www.astc.org.au) last Thursday (17-Mar). Chris Clarke from M&T Resources and co-founder of yourcareerhouse and has a strong 15 year background in sales, publishing and recruitment.

He shared some really good insights on the recruitment industry in Melbourne and ideas on how to build a strong personal brand leading to more opportunities.

In his presentation, Chris spoke about 3 things:

  • Resume Tips
  • Your personal brand
  • How to manage your recruiter

Resume Tips

It is safe to say that Chris goes through a fair amount number of Resumes. Every single day. In fact, in his experience, a lot of jobs these days see a minimum of 200 applications. A lot of these Resumes are not tailored to the job advert and are very general in nature, making it hard for them to stand out.

According to Chris, a recruiter has only up to 6 seconds to make up their mind about pursuing an application. The Resume should stand out on its own against 100+ other applications. A potential candidate may miss out on a good opportunity only because they cannot sell their skills effectively via the Resume. How do we fix this?

Tailor your Resume
It has probably been said a million times before, but Chris reiterated the fact that you need to tailor your Resume to fit the job requirements. Sure, it may seem like you are spending a lot of time tailor-fitting Resumes in the job search process, but if you really need that job, you will at least need to make an attempt to show that you are serious about it. The first place to do this is to have a Resume that specifically shows your skills match the client/job requirements.

The trick, according to Chris, is to lock away yourself for a good 3-4 hours to create multiple templates of your Resume. Templates that can be used to have tailored or personalised versions of your Resume. Whatever time you spend in a day (working out templates) will pay healthy dividends later.

A short and crisp Resume is a good Resume
Chris shared another insight from his experience working overseas and now Melbourne. He strongly believes Melbourne is a relationship driven city and it is about who you know more than what you know. Unlike in US or UK, recruiters here don’t mind seeing Resumes that go 4-5 pages, so long as they stay relevant. A 1-2 page Resume is great if you can fit everything on it.

One of the most common questions, posed especially by contractors with a lot of projects under their belts or industry veterans is around how much to put on a Resume. Chris recommended putting experience worth the last 10 years on a Resume and then talking about other experience when it comes to face-to-face interviews. Given the pace of technology and innovation across all fields, it is often advisable not to include experience from over 20-30 years, as they become obsolete pretty quickly.

Your personal brand

Chris reckons Linkedin is essentially a digital CV these days. Most of the recruiters or hiring managers turn to Linkedin first to find out more about an applicant before going down the phone or email path. Setting up and updating a Linkedin profile is easy; it is what you put on there and the way you tell a story is what sets it apart from other similar profiles. A good recruiter looks beyond the work experience and sees more of what value a applicant brings to the role.

How do you go about creating/selling your personal brand?
Chris suggests having the following information on Linkedin to add to your personal brand:

  • Treat the summary as an elevator pitch summarising your skills and experience and what value you can bring to an organisation.
  • Instead of merely listing down job responsibilities from previous roles, write a story about who you are as a person. Everyone loves a good story.
  • Mention what you are up to outside your work. Blogs, meetups, volunteering projects, community activities. This clearly shows how you are building your professional equity and becoming a thought leader in your area of expertise.

Manage your recruiter

Recruitment is not a one-way street and there is certainly no master-slave equation these days, says Chris. A good recruitment relationship is bi-directional and beneficially mutual.

Recruiters are essentially filters between clients and candidates and are good at relationship management, which is what makes them the ideal medium.

Working with recruiters
Chris shared some tips on how to get a foot in with your application:

  • After you have applied for a role, you are entitled to call the recruiter 24 hours later about the application. They may not respond right away, but your name will be on their minds when they get to the applications.
  • Sometimes, you could have all the skills, but that does not mean you should get the job. Culture fit is a very important criterion these days, so consider this when you apply for the role.
  • It is perfectly ok to call the recruiter and ask to meet them. This is a good opportunity to meet face-to-face and also explain what you do and what you can bring to the role.
  • You can ask the recruiter questions such as
    a. Do you understand what I do?
    b. How am I looking against other applicants?

Tips to engage with recruiters
Chris recommended the following strategy if you are in the market (or even otherwise) for keeping the job market and opportunities on the radar.

  • Engage with 2 big recruiters to know more about opportunities/openings across bigger organisations. Chris spoke about how big companies usually have a panel of 5-6 recruiters, so your chances may be hampered if you apply for the same role through different recruiters.
  • Liaise with 2 medium consultancies for roles across small-to-medium organisations.
  • Be on the books of a boutique (specialist) agency that specialises in tech writing or complementary areas.
  • Apply to companies directly. It never hurts to contact hiring managers at companies you want to work for directly.

And finally, when you do catch up with a recruiter for coffee, never offer to pay. Recruiters can and will usually expense it, says Chris.