The document discusses technical writing basics and the role of technical writers. It explains that technical writers produce documentation that explains how software or technologies operate or how they are used. The document outlines the software development process and how technical writers are involved in writing and preparing documentation throughout that process. It provides tips for technical writers, such as targeting the audience, separating information into modules, and reviewing user interface strings. Examples of documentation from SAP and HANA are also included.

1. Technical Writing Basics
Jordan Stanchev
SAP Labs Bulgaria
December, 2013

2. The User Experience and Documentation
Great tool, I know what will happen
when I click on the X sign.
Oops… What do I do now?!
© 2013 SAP AG. All rights reserved.
Public
2

3. Documentation
Software documentation or source code
documentation is written text that
accompanies computer software.
It either explains how it operates or how to use it, and
may mean different things to people in different roles
Source: http://en.wikipedia.org/wiki/Software_documentation
© 2013 SAP AG. All rights reserved.
Public
3

4. Technical Writer
A technical writer (also called a technical communicator)
is a professional writer who engages in technical writing and
produces technical documentation.
The Institute of Scientific and Technical Communicators has
defined the profession as preparing information which helps
users.
Source: http://en.wikipedia.org/wiki/Technical_writer
© 2013 SAP AG. All rights reserved.
Public
4

5. Documentation in the Software Development Process
Designs
the UI
Collects and
organizes the
requirements for
development
© 2013 SAP AG. All rights reserved.
Develops
the
software
Tests the
impleme
ntation
Writes & prepares
documentation
delivery
Reviews strings on the
screen
Creates proposals for
embedded information
Public
5

6. Target Your Audience
Who are you writing for?
What does he/she needs to achieve?
What does he/she need to actually do to achieve
the goal?
What are the concepts that the user needs to
know?
What is the additional, reference information
needed for that?
© 2013 SAP AG. All rights reserved.
Public
6

7. Information Modules
Write one task in a single topic.
Write conceptual information separate from the
task.
Write reference information in separate topics.
© 2013 SAP AG. All rights reserved.
Public
7

8. UI String Review
Show a confirmation message
upon successful creation of a
task
Clarify what is the
difference between
them, if any.
© 2013 SAP AG. All rights reserved.
Add tooltip and label
“Create” on the button.
Even better will be to
remove the arrow.
Public
8

9. Information Modules
Concept
Task
Reference
© 2013 SAP AG. All rights reserved.
Public
9

10. Documentation Examples
http://help.sap.com/nw74/
https://help.hana.ondemand.com
© 2013 SAP AG. All rights reserved.
Public
10

11. The User Experience with Documentation
Oops… What
do I do now?!
Great tool, I know what will happen
when I click on the X sign.
© 2013 SAP AG. All rights reserved.
Public
11

12. Have a question?
Jordan Stanchev
Knowledge Architect, SAP Labs Bulgaria
jordan.stanchev@sap.com

13. © 2013 SAP AG. All rights reserved.
No part of this publication may be reproduced or transmitted in any form or for any purpose without the express permission of SAP AG.
The information contained herein may be changed without prior notice.
Some software products marketed by SAP AG and its distributors contain proprietary software components of other software vendors.
National product specifications may vary.
These materials are provided by SAP AG and its affiliated companies ("SAP Group") for informational purposes only, without representation or
warranty of any kind, and SAP Group shall not be liable for errors or omissions with respect to the materials. The only warranties for SAP Group
products and services are those that are set forth in the express warranty statements accompanying such products and services, if any. Nothing
herein should be construed as constituting an additional warranty.
SAP and other SAP products and services mentioned herein as well as their respective logos are trademarks or registered trademarks of SAP AG in
Germany and other countries.
Please see http://www.sap.com/corporate-en/legal/copyright/index.epx#trademark for additional trademark information and notices.
© 2013 SAP AG. All rights reserved.
Public
13