Documentation guidelines

Jump to bottom

Joshua Smithrud edited this page Jul 13, 2022 · 7 revisions

Write from the second person. Use "you".
Only write about supported functionality.
Don't introduce new terminology.

Terminology

Fluid is a proper noun, but these are not:
- container
- service
- object
- driver
- runtime
- host
Fluid Framework is a proper noun
Fluid service, not Fluid server

Casing

Sentence case for headings
Container code, not Container Code
Distributed data structures, not Distributed Data Structures
URL, not url or Url
TypeScript
Node.js
npm (always lower-case)

Lists

Punctuation at the end of list items

Source-Code Documentation Guidelines

This wiki is focused on contributing to the Fluid Framework codebase.

For information on using Fluid Framework or building applications on it, please refer to fluidframework.com.