writing-help

Writing help README

This folder contains writing guidance to make FeatureBase docs:

• Consistent
• Easy to understand

Plan your content

If you fail to plan, you plan to fail. This goes double for documentation because it tends to be set-and-forget which leads to confusing, convoluted and repetitive content.

• Planning your content
• Writing modular content
• Reusing content with Jekyll include files

Writing rules

• Writing rules
• Procedure writing rules
• Hyperlink writing rules
• Highlighting important text

Need support?

• Contact the Docs feedback team if you have questions.