Skip to content
Crypto Doc Guy

Reference

In contrast to tutorials, which are designed for people who need to learn a new product or protocol, reference material is for people who already have an idea what they need, and just to check a few details. The style of reference is usually a lot stricter, because it is necessary to include all the relevant information, and because it’s easier to get the structure of a page when you’re already familiar with similar pages. Users don’t spend nearly as much time on reference as they do on tutorials, so it is important to be able to grasp everything quickly.

Additional information

Some users of reference are experts, and they just want the simple information ASAP. Other users are less experienced, and need more context to understand the information. I like to use the <details> ↗ tag to provide information to people who need it without slowing down those who don’t.

Reference can also include concepts which users needs to understand before the more technical sections make sense. Ideally, this information should be on a separate page so users can find it easily, without bothering those who don’t need it.

Samples