![\"Towards](\"https:\/\/miro.medium.com\/v2\/resize:fill:48:48\/1*CJe3891yB1A1mzMdqemkdg.jpeg\")
“A project is only as good as its documentation,” a quote from my previous 3-part article series that emphasizes the importance of documentation. Since then I have learned that there are different types of documentation, the most common are:<\/p>\n
Technical documentation<\/strong>: Describe the technical aspects of the internal operation of the project, it can be process documentation or product documentation.Business documentation<\/strong>: Describe what business problems they solve or what business goals they achieve<\/p>\n There is a type of documentation that falls in between, these are manuals, guides and tutorials. This is especially important if you want to technical users<\/strong> to work on or use your project, or business users <\/strong>to understand your project and gain buy-in.<\/p>\n As documentation becomes more complex with more content, it can be difficult to display it in one easy to use and readable format<\/strong>. For example, tutorials should not be embedded in technical documentation, and ideally there should be a separate tab or navigation section between them.<\/p>\n This made me explore more Sphinx themes to make my documentation more beautiful and to be able to manage more information. I ended up being attracted Sphinx-Material<\/a> i Sphinx-Immaterial<\/a> themes that implement the MkDocs Material theme. After many tweaks, and still not getting the results I wanted, I changed MkDocs<\/a> and finally understood the hype about MkDocs.<\/p>\n Having tried several methods and documentation topics, I will try to compare them, focusing on the features won and lost<\/strong> of switching from Sphinx to MkDocs. Finally, this article will end with important MkDocs settings to incorporate for more optimal documentation!<\/p>\n note<\/strong>: If you are interested, this is the one link<\/a> in my documentation made with the Sphinx-Material theme, and this is the link<\/a> to the same documentation made with MkDocs \ud83d\ude42<\/p>\n