Quantcast
Channel: Mattermost Discussion Forums - Latest posts
Viewing all articles
Browse latest Browse all 25778

Mattermost Documentation Style Guide

$
0
0

I think one place it start is finding an example of some "quick work" contributed by developers, and think about all the different corner cases to cover.

Here's an example of some fresh documentation that is technically accurate, and probably waiting for guidelines to be applied.

Stuff to think about:

  • When to use the name of the command vs. the name of tool (e.g. Load Test vs. loadtest)
  • When to use pre-formatted text for commands, e.g. loadtest vs loadtest
  • What's the principle for organizing headings and subheadings?

The MongoDB Style Guide is a good reference as well. We base a lot of our docs work off MongoDB docs.


Viewing all articles
Browse latest Browse all 25778

Trending Articles



<script src="https://jsc.adskeeper.com/r/s/rssing.com.1596347.js" async> </script>