Skip to content

slavipande/Doc-Exercises

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

11 Commits
 
 
 
 
 
 

Repository files navigation

Doc Exercises

This is Svetoslav Pandeliev's documentation tryouts

![@slavipande][@slavipande avatar]

Svetoslav Pandeliev · @slavipande :octicons-calendar-24: October 11, 2021 · :octicons-clock-24: 3 min read ·

The following are the main principles of technical writing

1548052757

Principle #1: Decide whom are your writing for!

Principle #2: Decide on the information needs of your user

Principle #3: Decide on the way you are going to address your user - which S&Gs to apply

Principle #4: Decide on the deliverable to create

Principle #5: Decide on the tool you will use to create your content

Principle #6: Decide on the structure of your content

Principle #7: Decide on the information channel you are going to use

Principle #8: Write the docu

Principle #9: Use images and videos as appropriate

Principle #10: Publish your first version

Principle #11: Collect input and improve the content

Principle #12: Repeat

<script type="text/javascript"> var Tawk_API=Tawk_API||{}, Tawk_LoadStart=new Date(); (function(){ var s1=document.createElement("script"),s0=document.getElementsByTagName("script")[0]; s1.async=true; s1.src='https://embed.tawk.to/5db3ffbddf22d91339a12703/default'; s1.charset='UTF-8'; s1.setAttribute('crossorigin','*'); s0.parentNode.insertBefore(s1,s0); })(); </script>

About

This is a repo for my documentation

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published