/plushcap/analysis/edgedb/make-your-users-happy-by-keeping-it-ryl-in-documentation

Make your users happy by keeping it RYL in documentation

What's this blog post about?

The principle of DRY (Don't Repeat Yourself) is a fundamental concept in software development that helps maintain clean and efficient code by avoiding redundancy. However, applying this principle to technical documentation can sometimes be counterproductive. While DRY can make code easier to maintain and less buggy, it may create unnecessary friction for users trying to learn from the documentation. In some cases, repeating information in documentation (RYL - Repeat Yourself Liberally) can improve user experience by making essential information more accessible and reducing the need for constant navigation between different sections of the documentation. This approach is particularly useful in tutorials that aggregate information from various sources or when explaining non-intuitive behavior that may cause user frustration. Ultimately, striking a balance between DRY and RYL principles in technical documentation depends on the specific context and requirements of the project. It's essential to prioritize user experience and ensure that users can easily find the information they need without being overwhelmed by excessive repetition or forced to navigate through complex documentation structures.

Company
EdgeDB

Date published
Aug. 4, 2023

Author(s)
Devon Campbell

Word count
2023

Hacker News points
5

Language
English


By Matt Makai. 2021-2024.