A Guide to Writing Your First Software Documentation
Maria Antonietta Perna covers the importance of good software documentation, showing you how to get up and running with your first software documentation.
Tag: documentation
Design and Build Your Own JavaScript Library: Tips & Tricks
Tim Severien discusses a wide variety of tips and tricks to build your own JavaScript library, ranging from API design to testing and documentation.
The Importance of Writing Code That Humans Can Read
Tim Severien shares a variety of tips and tricks to help you write readable and more maintainable code — something your future self will thank you for.
Fast Multi-language Docs with SitePoint’s RTDSphinx-PHP
SitePoint's RTDSphinx-PHP project is a skeleton for Sphinx that's ReadTheDocs-friendly, PHP-enabled and localization-optimized out of the box.
Using Sphinx for PHP Project Documentation
ReadTheDocs is a popular platform for free hosting of Sphinx-generated project documentation. Bruno shows you how to use it when documenting PHP projects!
Building Product Documentation with MkDocs
Agbonghama Collins introduces MkDocs, a free, static site generator for building project documentation.
Generating PHP Documentation with Sami
Younes Rafie demonstrates using Sami, the documentation generator, to extract docs from your code's docblocks - even across several tagged versions
RAML, the RESTful API Modeling Language
Lukas White explains RAML, the RESTful API Modeling Language, which you can use to scaffold, test, mock and document your API endpoints.
Writing API Documentation with Slate
Lukas White introduces Slate - a Markdown way of writing your API documentation - and shows you how to publish it to Github pages for free hosting
Keeping Your PHP Code Well Documented
Learn to keep your PHP code well documented through some experts tips from Jacek Barecki
A Look at DevDocs.io
DevDocs.io is a very slick and fast reference manual aggregator for popular front-end languages and libraries.
Introduction to PhpDoc
Read Introduction to PhpDoc and learn with SitePoint. Our web development and design tutorials, courses, and books will teach you HTML, CSS, JavaScript, PHP, Python, and more.