Browsing Tag
documentation
16 posts
Python Documentation With Docstrings and Sphinx
pylint Prep Docstrings Documentation Generation With sphinx Conclusion In the last installment of the series we looked at…
Crafting Software Architecture artefacts: Transformer Chronicles
Introduction: Software architecture documentation plays a vital role in ensuring effective communication, knowledge transfer, system understanding, maintenance, compliance,…
Best Practices for Code Documentation: Ensuring Clarity, Maintainability, and Collaboration in Software Development
Introduction: Code documentation is a crucial aspect of software development that helps ensure clarity, maintainability, and collaboration among…
Documentation…What do people NEED to know!?
The web-dev journey with ruby on rails this past year has been quite the rollercoaster ride. I have…
Best API documentation tools you need
You could document APIs manually or use a documentation tool for that. API has specifications for each type…
Bing Webmaster Tools De-indexed My Docs Site and Increased My Cognitive Load
On August 24th, I was listening to @radiomorillo‘s The Developer’s Guide to SEO Audits in a panic because…