View
28
Download
4
Category
Preview:
Citation preview
보라언니 테스트
통과하는 법
What is Technical Writing?
Examples – Dummies book
TO DESIGN
& IMPROVE
THE PRODUCT
Require-ment
Specifica-tion
De-velop-mentRe-
quests
Change Re-
quests
Design Specs
• Technical & Product Briefs
• Product Brochures• Website Contents• Press Release
• User Guide• Configuration Guide• Application Guide• Data Sheet• Maintenance &Trouble Shooting
Guide
TO SELL THE PRODUCT
TO HELP THE CUSTOMER
TO HELP THE STAFF OF CUS-TOMER
OPERATE THE PRODUCT
Case-based Tutorials * Step-by-step Task Lists * Online help in CHM/HTML
TO TEST AND INSTALL THE PROD-UCT
TEST CASES USER ACCEPTANCE TEST (UAT) INSTALLATION GUIDES TECHNICAL WRITING REQUIREMENTS
AND FUNCTIONAL SPECIFI-CATIONS
DESIGN DOCUMENTS CONTROL DOCUMENTS
• PLANNING
• ANALYSIS
• DESIGN
• DEVELOP
• TEST
• IMPLEMENTATION
• MAINTENANCE
• PLANNING
• Define the Scope ( 무엇에 대해서 , 범위는 얼만큼 ?)
• Schedule / Monitor ( 어떻게 , 어떤 스케줄로 진행할 것인가 ?)
• ANALYSIS
• DESIGN
• DEVELOP
• TEST
• IMPLEMENTATION
• MAINTENANCE
• PLANNING
• ANALYSIS
• Persona needs ( 독자가 필요한 정보를 어떻게 전달할 것인가 ?)
• DESIGN
• DEVELOP
• TEST
• IMPLEMENTATION
• MAINTENANCE
KNOW YOUR AUDIENCE!!!!! IS HE/SHE A NOVICE? OR AN EXPERT?
Process Document?
Process Document?
Used by.. Managers, engineers, testers and marketing professionals
Provides information related to the development and maintenance of system
Process Document?
EXAMPLES
Estimate, plans, and schedulesReports
StandardsWorking Papers
Electronic mail / messages / notes
User Document?
User Document?
Give customers the information they need
to use the product
Used by…Users, End-Users, System Adminis-
trators
User Document?
EXAMPLES
Functional DescriptionSystem Installation
System ConfigurationIntroductory ManualSystem Reference
HOW FOR-MAL
WILL IT BE?
• PLANNING
• ANALYSIS
• DESIGN
• Blueprint & Interface
• DEVELOP
• TEST
• IMPLEMENTATION
• MAINTENANCE
Good ImpressionProfessionalStructureLogicalInformative
OUTLINE
STRUCTURE FUNCTION
Scientific JournalAbstract – People have to know what this experiment is about just by reading the abstractIntroduction – It delivers the basic information about the sci-entific theory and the techniques used for this experimentReagent Used – Reagent table shows general information ab-out used chemicals: name, structure, amount used and molar weightProcedure – This gives instruction for the experiment.Results – It shows the result of the each procedure.Discussion – This section explains why the experiment result-ed in such way based on scientific knowledgeConclusion – It concludes the experiment results and gives f-urther suggestions for those who would repeat this experiment
The most
IMPORTANT INFORMATION
comes before other information.
WARNING : You MUST write this warning on the top of the document because it keeps the readers safe.This slide tells you how to structure the doc-
ument in order to help the reader find their information easily.Donec id elit non mi porta gravida at eget metus. Fusce dapibus, tel-lus ac cursus commodo, tortor mauris condimentum nibh, ut fermen-tum massa justo sit amet risus. Etiam porta sem malesuada magna mollis euismod. Donec sed odio dui. Donec id elit non mi porta gravida at eget metus. Fusce dapibus, tellus ac cursus commodo, tor-tor mauris condimentum nibh, ut fermentum massa justo sit amet risus. Etiam porta sem malesuada magna mollis euismod. Donec sed odio dui. Donec id elit non mi porta gravida at eget metus. Fusce dapibus, tellus ac cursus commodo, tortor mauris condimentum nibh, ut fermentum massa justo sit amet risus. Etiam porta sem malesuada magna mollis euismod. Donec sed odio dui.
Application........62,45,103
Browswer……………………45
Computer……1,24,68,109
Decryption……..………….51
Electronic………….34,35,36Format…………………………8
Gangnam Style ……….1,2
HTML…………104,105,106
Junghwan…………….1,2,3,4
Library…………………66,108Malware……..34,78,96,108
NSHC……………1,2,3,4,5,6,7
Operation System…45,46
PC…………………...77,90,102
Reference..1.2.3.4.5.98,99SSL………...........................113
TextView………57,58,59,60
User…….….22,23,24,89,90
Windows………….………193
Zombies…1-3,4-6,99-100
INDEX
PREREQUISITE GUIDE
Make it easier for the writer When the contents overlap See pg. 34 ( 34 페이지 참조 )
• PLANNING
• ANALYSIS
• DESIGN
• DEVELOP
• Research ( 필요한 자료를 조사 , 연구 및 수집 )
• Writing ( 모은 자료를 바탕으로 글을 씁니다 )
• TEST
• IMPLEMENTATION
• MAINTENANCE
Importance of Simplicity
At the Reader’s Per-spective
CAN I DO THIS BY MY-
SELF?
T.M.I.
COMPLEX VAGUE
Three Things to Avoid
=
Example - IKEA
Example 1
Example 2
제품 접수 카드를 모두 작성하신 뒤 돌려주시면 구매 날짜를 증명해 드리겠습니다 . 보증을 받기 위해서 구매의 증명서 원본을 가지고 계시길 바랍니다 . 만일 구매 날짜를 모르신다면 제품 제조일을 알려주십시오 .
구매 날짜 증명작업을 빨리 진행할 수 있도록 빠른 시일 내에 제품에 포함된 접수 카드를 모두 작성하여 돌려 주십시오 . 그러나 접수 카드를 제출한다고 해서 소비자가 보증을 받기 위해 필요한 영수증 원본을 가질 의무가 없어지는 것은 아닙니다 . 보증을 받을 시 , 구매 날짜를 증명 할 만한 서류를 가지고 있지 않다면 제품 제조일로 대신 적용할 것입니다 .
이중 부정 금지 대명사 사용 억제
예의와 격식이 있게추측 표현 자제긍정적인 말투
다의적 표현 사용 금지정확한 숫자 표기 한 문장에 하나씩
수식어는 피수식어 가까이능동적인 문장
문장의 평행구조 전치사의 올바른 사용
문장은 간결하게
36Copyright All Right Reserved by kimdaeyoungⓒ
Admin Console
Admin Console 컨텍스트 루트 ( 접근할 주소 ) 를 지정하고 ,
메타파일 체크 후 설치 완료한다 .
• PLANNING
• ANALYSIS
• DESIGN
• DEVELOP
• TEST
• Validate ( 쓰여진 글이 괜찮은지 ? 다음 단계로 넘어가도 될는
지 ?)
• Refine ( 추가해야 하거나 고쳐야 할 것은 없는지 , 독자의
입장에서 찾고 이해하기 쉽도록 쓰여졌는지 등 )
• IMPLEMENTATION
• MAINTENANCE
• PLANNING
• ANALYSIS
• DESIGN
• DEVELOP
• TEST
• IMPLEMENTATION
• User Test ( 사용자 테스트 )
• Publish ( 출판 )
• MAINTENANCE
HTMLHTML Help
XML/DocBookXML/DITA
PDFDOCRTF
Appearance AND Layout Appearance ONLY
[F1]
HTML Help
*.htm, *.chm
Printed / Online Manual
Read Me
Readme.txtReadme.docReadme.htmReadme.rtf etc.
• PLANNING
• ANALYSIS
• DESIGN
• DEVELOP
• TEST
• IMPLEMENTATION
• MAINTENANCE
• Updates – via Customer Help Desk
• PLANNING
• ANALYSIS
• DESIGN
• DEVELOP
• TEST
• IMPLEMENTATION
• MAINTENANCE
• Updates – via Customer Help Desk
적은 문서로 적은 시간과
적은 노력으로 최대의 결과를
Recommended