Good documentation is essential for any project, and it is important to ensure that it is accessible to people with a wide range of skill levels. In order to make documentation as accessible as possible, we propose a new paradigm called ELI5/15/25.
The ELI5/15/25 paradigm consists of three levels of documentation, each catering to a different skill level:
This level of documentation is designed for people who are new to the topic or have little prior knowledge. It should provide a high-level overview of the topic and use simple, easy-to-understand language.
This level of documentation is designed for people who have some basic knowledge of the topic, but may not be experts. It should provide more detailed information and explanations than the ELI5 level, but still use language that is easy to understand.
This level of documentation is designed for people who are experts in the topic. It should provide in-depth information and technical details that are relevant to the topic.
In order to implement the ELI5/15/25 paradigm, documentation should be organized into sections or subsections corresponding to each of the three levels. For example, a section titled "ELI5: Introduction to X" would provide a high-level overview of X, while a section titled "ELI25: Advanced techniques for X" would provide detailed technical information.
It is also important to ensure that the language used in each level of documentation is appropriate for the intended audience. ELI5 sections should use simple, easy-to-understand language, while ELI25 sections can use more technical terms and jargon.
The paradigm has several benefits:
-
It makes documentation more accessible to people with a wide range of skill levels. By providing different levels of information, people can easily find the information that is most relevant and understandable to them.
-
It helps to organize documentation in a clear and logical way. By dividing documentation into different levels, it is easier to find the information you are looking for and to understand the relationships between different topics.
-
It encourages the use of clear, concise language in documentation. By specifying that ELI5 sections should use simple language, it encourages writers to be concise and to avoid using technical terms or jargon when it is not necessary.
In conclusion, the ELI5/15/25 convention is a simple and effective way to make documentation more accessible and easier to understand. By providing different levels of information and using clear, concise language, it helps to ensure that documentation caters to people with a wide range of skill levels. We believe that this convention would be a valuable addition to any documentation project.
This work is licensed under a
CC0 1.0 Universal (CC0 1.0) Public Domain Dedication.
To the extent possible under law, Akhil Burle has waived all copyright and related or neighboring rights to ELI5/15/25. This work is published from: United States.
