Technical writing for developers: Virtual classroom courses

Improve your developers’ writing skills

You’ll have access to a framework and templates to help you with your writing. You’ll also have the opportunity to practice and review your work.

Virtual Classroom

Cherryleaf offers the course in two versions:

  • With Google’s courseware.
  • With Cherryleaf’s courseware.

Both courses will improve your technical writing skills. You’ll gain confidence you’re approaching each writing project in the right way, and creating content that follows best practice.

The courses can be delivered to teams within organisations, in a virtual classroom format. We also offer an e-learning course for individual students.

Technical Writing for Developers - With Google's courseware

Cherryleaf can deliver two developer technical writing classes that Google has created and delivered to its own staff.

There are two courses for groups:

  • Technical Writing for Developers Part One
    • This covers the critical basics of technical writing. It teaches you how to write clearer technical documentation.
  • Technical Writing for Developers Part Two
    • This covers intermediate topics in technical writing and communication. It teaches topics such as creating sample code, tutorials, images and diagrams.

Technical Writing for Developers - With Cherryleaf's courseware

With this option, you can extend and customise the course, so that it covers the specific topics your developers need. This course covers the same topics as Google’s course, plus a few more.

We typically cover:

 

Writing clearly

  • Writing clearer sentences
  • How to write instructions
  • The basics of English grammar
  • Using the active voice
  • Style, tone and voice

Writing for your audience

  • Identifying your target audience
  • Understanding your target audience’s needs
  • Support reading to do, study, and locate

Designing your information

  • Headings
  • Links
  • Lists

Structuring your information

  • Chunking your content into topics
  • Sequencing the information
  • Organising large documents

Defining your document’s purpose and scope

  • Defining your document’s purpose and scope
  • Writing different types of documents
  • Defining the outcomes

Planning and outlining  your writing

  • Top down planning
  • Templates
  • How to write and present different types of information

Writing in Markdown and Asciidoc

  • Using Markdown (or Asciidoc) to write documentation

Using images and diagrams

  • Planning and creating diagrams
  • Using images
  • Using screenshots

Writing clear code samples

  • Writing code samples
  • Using Markdown, HTML, and Word to write code samples

Reviewing and editing your content

  • Verification and validation
  • Editing
  • Proofreading

Software tools

Maintaining the content

Measuring if it works

elearning course option for individual students

We have developed an elearning course as alternative for individuals who are not able to attend group courses.

It contains recorded videos, exercises, checklists, and framework documents.

Go to the elearning course website

 

Who are these courses for?

The courses have been designed for:

  • Software engineers
  • Software engineering students

In addition, other people involved in software development (such as product managers) can benefit from these courses, especially if they:

  • Want to communicate more clearly and effectively
  • Want to know how little, or how much, they should write
  • Struggle with planning their writing
  • Want people to answer their own support questions

Prerequisites

Delegates need to have basic writing proficiency in English and coding (for the coding exercise).

What will I learn?

You’ll learn:

  • How to communicate clearly, even if writing doesn’t come naturally
  • How to save time and write in an efficient way
  • Confidence in the work you produce

You’ll have access to a framework and templates to help you with your writing.

Delivery format

Technical Writing for Developers – Google courseware

Technical Writing for Developers Part One and Technical Writing for Developers Part Two courses are delivered in a virtual classroom format. They include some online, pre-class, self-study teaching materials.

Each course comprises:

  • 2-3 hours of pre-course self-study learning and exercises
  • 2.5 hours virtual classroom learning

Technical Writing for Developers – Cherryleaf courseware

This course is currently offered to teams as a virtual classroom course, delivered over Microsoft Teams or Zoom. The course is split into two sessions of 3 hours each, delivered on different days.

e-learning course for individuals option

Cherryleaf’s Technical Writing for Developers e-learning course is taught completely online; there is no need for any classroom-based teaching with this option.

The course typically takes 1 to 1.5 days to complete, but you can go at the pace that suits you.

Go to e-learning course

 

Accreditations and certificates

Google has no plans to accredit any trainer or organisation delivering its course. It is not planning to accredit any of the delegates, or to provide certificates.

However, Cherryleaf can provide a course certificate to delegates at the end of the course.

Course options and prices

Virtual classroom

The prices for the group courses depend on the number of delegates taking them. If you have a rough idea of numbers, then we can put together a quotation for you.

Prices relate to the provision of a trainer to facilitate the classroom element of the courses, and any non-Google training materials used in the courses.

Contact us for more details.

elearning course option

See: Technical writing for developers elearning course

Contact us for more information

contact cherryleafUse our training services contact form to tell us more.

If you can’t see the course you want, we may still be able to meet your needs.