DEV Community

Cover image for Try to sketch your technical docs
Antoine
Antoine

Posted on

Try to sketch your technical docs

Photo by Nicolás Pinilla on Unsplash

It's very complicated to do good documentation.
It has to be organized, accurate, and easy to read. Visual can help greatly the documentation. And organic visuals are great for people to get an idea.

That's why I'm trying to use sketch to understand what we document, and how to to do it.

I have found 2 tools:

So far, i have identified the following:

  • identify which actors the drawings
  • think about your design
  • try to draw a complex scenario to find missing things
  • draw

Hope this helps !

Top comments (0)

Billboard image

The Next Generation Developer Platform

Coherence is the first Platform-as-a-Service you can control. Unlike "black-box" platforms that are opinionated about the infra you can deploy, Coherence is powered by CNC, the open-source IaC framework, which offers limitless customization.

Learn more

👋 Kindness is contagious

Engage with a sea of insights in this enlightening article, highly esteemed within the encouraging DEV Community. Programmers of every skill level are invited to participate and enrich our shared knowledge.

A simple "thank you" can uplift someone's spirits. Express your appreciation in the comments section!

On DEV, sharing knowledge smooths our journey and strengthens our community bonds. Found this useful? A brief thank you to the author can mean a lot.

Okay