June 2023
Beginner
336 pages
6h 52m
English
Content preview from Technical Writing For Dummies, 2nd Edition
Become an O’Reilly member and get unlimited access to this title plus top books and audiobooks from O’Reilly and nearly 200 top publishers, thousands of courses curated by job role, 150+ live events each month,
O’Reilly covers everything we've got, with content to help us build a world-class technology community, upgrade the capabilities and competencies of our teams, and improve overall team performance as well as their engagement.I wanted to learn C and C++, but it didn't click for me until I picked up an O'Reilly book. When I went on the O’Reilly platform, I was astonished to find all the books there, plus live events and sandboxes so you could play around with the technology.I’ve been on the O’Reilly platform for more than eight years. I use a couple of learning platforms, but I'm on O'Reilly more than anybody else. When you're there, you start learning. I'm never disappointed.I'm always learning. So when I got on to O'Reilly, I was like a kid in a candy store. There are playlists. There are answers. There's on-demand training. It's worth its weight in gold, in terms of what it allows me to do.
Appendix E
Technical Writing Brief
No matter what technical writing responsibilities you have, this Technical Writing Brief is the first step in the writing process. (You’ll find a full explanation in Chapter 3.) Feel free to make a copy of this brief as you work on each new project. With just a little practice, it will help you to write with confidence and competence, as well as save you lots of time and frustration.
Many participants in the technical writing workshops I facilitate start by saying, “I don’t have time to fill out this out.” After working with it they say, “I don’t know how I ever got along without it.” Many even claim to have cut writing time by 30 to 50 percent. Share it with your team; they’ll thank you!
About the Document
- Type of document
- Presentation context (Paper? Online? Streaming? Simulation? Combination?)
- Target date for completion
Learner Profile
- Who are the learners?
- Are they technical, nontechnical, or a combination?
- Are they internal (to your company), external, or both?
- Do you have multi-level learners?
- If so, what percentage are there of each?
- What do the learners need to know about the topic?
- What’s their level of the subject knowledge, if any?
- How do they process information?
- What jobs do they perform?
- What is their attitude toward the topic? (Positive? Neutral? Negative?)
Key Issues
- What are the key issues to convey? (A is the most important.)
- _____________________________________
- _____________________________________
- _____________________________________ ...
Become an O’Reilly member and get unlimited access to this title plus top books and audiobooks from O’Reilly and nearly 200 top publishers, thousands of courses curated by job role, 150+ live events each month,
and much more.
Read now
Unlock full access
More than 5,000 organizations count on O’Reilly
O’Reilly covers everything we've got, with content to help us build a world-class technology community, upgrade the capabilities and competencies of our teams, and improve overall team performance as well as their engagement.Julian F.
I wanted to learn C and C++, but it didn't click for me until I picked up an O'Reilly book. When I went on the O’Reilly platform, I was astonished to find all the books there, plus live events and sandboxes so you could play around with the technology.Addison B.
I’ve been on the O’Reilly platform for more than eight years. I use a couple of learning platforms, but I'm on O'Reilly more than anybody else. When you're there, you start learning. I'm never disappointed.Amir M.
I'm always learning. So when I got on to O'Reilly, I was like a kid in a candy store. There are playlists. There are answers. There's on-demand training. It's worth its weight in gold, in terms of what it allows me to do.