diff options
| -rw-r--r-- | spm-slides.tex | 30 |
1 files changed, 17 insertions, 13 deletions
diff --git a/spm-slides.tex b/spm-slides.tex index 6a2f6d1..c0e9883 100644 --- a/spm-slides.tex +++ b/spm-slides.tex @@ -711,19 +711,23 @@ or something else. Good examples: \end{itemize} Contrast Developer Guidelines with Developer Documentation. -{\bf Documentation.} Maintain FAQs (both online and in the -distribution). There needs to be something for people to read, even if -it's rudimentary and incomplete. The most important documentation for -initial users is the basics: how to quickly set up the software, an -overview of how it works, perhaps some guides to doing common tasks -(tutorial). Plain text, HTML, Markdown, reStructuredText, Read The -Docs (an online documentation tool at \url{https://readthedocs.org}). Tell the readers the known -deficiencies, issues. {\bf Put everything in one page}. - -{\bf Developer documentation}. Developer guidelines tell programmers how to get along with each -other; developer documentation tells them how to get along with the code itself. - -{\bf Hosting}. A website for users and a website for developers. +{\bf Documentation.} Essential. People need something to read about your project. Make people's +lives easier. Maintain FAQs (both online and in the distribution). An all-in-one page so that +people can search. Fine to be rudimentary and incomplete. The most important documentation for +initial users is the basics: how to quickly set up the software, an overview of how it works, +perhaps some guides to doing common tasks (tutorial). Plain text, HTML, Markdown, {\em +reStructuredText}, Read The Docs (an online documentation tool at \url{https://readthedocs.org}). +Tell the readers the {\bf known deficiencies}, issues. {\bf Put everything in one page}. Hard to +see things form the reader's point of view. + + +{\bf Developer documentation}. Developer guidelines tell programmers how to get along with each +other; developer documentation tells them how to get along with the code itself. Wikis (need to be +actively maintained.) + +{\bf Hosting}. A website for users and a website for developers (code repo, bug tracker, +development wiki, mailing lists, etc). Two sites link to each other. Not important in the beginning. +Canned hosting. {\bf Choosing a license and applying it}. |