-
-
Notifications
You must be signed in to change notification settings - Fork 92
Writing Style
sven edited this page Aug 16, 2017
·
12 revisions
- "shell commands" should be in reST style for commands, also in written text
- make sure of glossary use
- topic descriptions ?
- header always with Capital letter for every first letter in every word
- links should be "in text" and not in the footer
- "write out acronyms, meaning if you write ttw do it like ttw (trough the web) for teh first time you use it in a document.
Writing is not coding !
Please use -
and not _
for naming folder
Bad: mastering_plone
Good: mastering-plone
Underscores are only used for templates like _templates
and for static directories like _static
.