Doc guidelines, standards, and tools

Here are some tools, resources, and guidelines for creating docs.

Diagrams

• Draw.io (also known as diagrams.net) can make visually pleasing diagrams with minimal effort.

  Some tips:

  • If your diagram contains an element with wrapped text, design that element first and then use it as the starting point for the rest of your elements.

  • Strongly recommend using a mouse, trackball, or precision pointing device. Alignment is difficult when using gestures or other touch interface controls.

  • Set a background color in document properties; otherwise, your final diagram might be transparent.

  • If saving is problematic, save to your local device and then move the file to your intended destination.

• asciiflow creates simple line drawing diagrams using ASCII line drawing characters. Helpful for text file illustrations.

• Pencil project is a cross-platform Visio alternative.

See also

• Hugo
• Markdown
• MKDocs