Skip to main content

Writing Tools

There are several writing tools you can use to improve your style and grammar , structure, add diagrams and learn about markdown and Docusaurus components.

Style and Grammar​

Grammarly​

Grammarly is browser extension that checks your spelling, grammar, punctuation, style and even writing voice and tone.

Hemingwayapp​

Hemingwayapp highlights and corrects grammar, fluency, and sentence structure in order to help your writing read and look better.

IOTA Wiki Style Guide​

This wiki has its own style guide you can use so your writing is cohesive with the rest of the wiki.

Markdown and Components​

Markdown Guide​

This wiki uses Markdown as primary language. You can use the cheat sheet to get started in no time.

Docusaurus​

This wiki is built using Docusarus. You can use their documentation to learn all about its many features.

Diagrams​

Diagrams.net​

diagrams.net (formerly draw.io) is free online diagram software. You can use it as a flowchart maker, network diagram software, to create UMLs online.

Design Resources​

You can find IOTA Wiki themed graphic resources in the Design Resources repository. You can add this repository to diagrams.net in three simple steps:

  1. Open diagrams.net.
  2. Click File > Open Library From > URL.
  3. Paste the RAW URL of the library, for example:
https://raw.githubusercontent.com/iota-wiki/Design-Resources/main/flowchart_library/flowchart.xml

Structure​

Diataxis​

Separating concerns in documentation makes it easier for the user to find what they are looking for. This wiki uses Diataxis to organize its documentation into four distinct categories. You can read more about Diataxis in the Wiki in the software documentation structure article.

IOTA Wiki​

Templates​

The IOTA wiki hosts templates you can use to start your project's documentation and write a tutorial