Skip to main content

Title

Text below the Title

Overview​

Overview of the document. This can also be a table of contents but the way that docusaurus automatically generates a table of contents based on the h1, h2, and h3's on the right sidebar makes this a little obsolete in most cases.

What You Will Learn / Readable Table of Contents​


This is a simple code box. This is a differnt way make certain parts stand out and also add code blocks.

- Problem. Note the key topic or problem of your document.
- Method. State your main approach to solving the problem.
- Results. Provide one or two important results.
- Conclusion. Note your main conclusion.

Write Excellent docs​

Give writing documentation and blogs the same care and consideration as we do to the features we ship.

Case Driven Documentation / Goal Driven Documentation​

The main idea is to make the cases or goals of your user / reader the focus point of your documentation instead of just describing interface elements on the nav and page.

Instead of writing how to write a function... you would instead write how to write a function that does X or solves Y problem.

Write for the user​

Write documentation and blogs that help people achieve their goals. Remember, we are writing docs and blogs for people, not for machines.

Truthfully, people don't mind reading and may even be thankful for the documentation as long as it's actually helpful to them.

To conclude, the goal of a technical docs and blogs is not only to be accurate and consistent but also honest, helpful and human.

Honest by communicating the pros and cons of a solution to build trust.

Helpful by helping users to succeed as theirs is ultimately our success.

Human because we want to feel familiar and approachable.