Skip to content

jan379/structuredDocumentation

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

6 Commits
 
 
 
 
 
 
 
 

Repository files navigation

How to structure user facing documentation

These are my reader notes written down in a shell script reading Daniele Procida on documentation.

You can simply execute the script genSkeleton.sh and get a directory structure you can fill with content + short summaries of the specific kind of what criteria might be right for different kind of user facing documentation.

About

helper script to write the right documentation

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages