Mirrors/super-productivity
1
0
Fork 0
mirror of https://github.com/johannesjo/super-productivity.git synced 2026-01-23 02:36:05 +00:00
Code Issues Projects Releases Wiki Activity
super-productivity/docs/wiki/3.00-Reference.md
Corey Newton f9a328022d
docs(wiki): initial revision (v0.1) 
Contains both a first-draft of content as well as
a comprehensive GH Action to replicate from
docs/wiki to the `.wiki` sub-repo. The linting is
non-blocking at the moment.

- the existing markdown linking appears reliably
rendered in GH but more testing needed.
- style guide for contributions/expectations needs
to be added to the wiki
- **a significant re-work of the README** to
re-direct users to the Wiki is needed to avoid
doc duplication
- updates to the PR templates and contributor
guidelines to emphasize the importance of adding
documentation is still needed
2026-01-20 03:04:08 -08:00

1.1 KiB
Executable file
Raw Blame History

Index of Reference Material

Uncategorized

3.01-API 3.02-Settings-and-Preferences 3.03-Keyboard-Shortcuts 3.04-Short-Syntax

How to Write Reference Material

The 3.XX sections should strive to follow these https://docs.openedx.org/en/open-release-sumac.master/documentors/concepts/content_types.html#id5.

  • Do nothing but describe. References have one job: to explain and do that accurately and comprehensively.
  • Be accurate. These descriptions must be accurate and kept up-to-date.
  • Provide examples. It is a valuable way of providing illustrations that help readers understand the references without becoming distracted from the job of describing them.
  • The documentation structure should mirror the product’s structure so the user can work their way through it simultaneously. It doesn’t mean forcing the documentation into an unnatural structure. What’s important is that the documentation should help make sense of the product.
  • Be consistent in structure, language, terminology, and tone.