Technical writing for developers
Cherryleaf's Technical Writing for Developers e-learning course teaches the basics of technical writing to developers who are writing documentation. It teaches you how to write clearer technical documentation, plus topics such as creating sample code, tutorials, images and diagrams.
The course 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.
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
Delegates need to have basic writing proficiency in English.
What will I 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.
You can also get feedback on your completed exercises.
The course typically takes 1 to 1.5 days to complete, but you can go at the pace that suits you.
Cherryleaf is a technical writing services company formed in 2002 by people with a passion for technical communication and learning development.
Cherryleaf is recognised as a leader within the technical communication profession. Our staff have written articles for the Society for Technical Communication's (STC) Intercom magazine, the Institute of Scientific and Technical Communicator's Communicator journal and tekom's TCWorld magazine. They've also written books on technical communication. We've presented webinars for Adobe, Madcap Software or the STC, and we've spoken at various conferences around the world.
Today, organisations throughout Europe use Cherryleaf’s services so they can provide clear information that enables users and staff to complete tasks productively.
StartWriting clearly (24:47)
StartWriting headings, lists, and links (7:00)
StartStructuring the information (13:12)
StartPlanning and outlining your writing (7:43)
StartUsing Information Types (15:34)
StartUsing images and videos (7:58)
StartWriting in Markdown
StartWriting clear code samples (8:22)
StartReviewing and editing your content (8:40)