Archive for the ‘documentation’ Category

On Writing Feature Requirements

Posted on: No Comments
I have been asked to lead product development on a team. This is somewhat of a new journey for me because I'm generally used to calling myself a web designer rather than a product manager or strategist. The toughest part of this job for me has been org...

Amazon Product API Exploration: Let’s Build a Product Searcher

Posted on: No Comments
In this tutorial, you'll take a look at Amazon's Product Advertising API. It's an API that allows developers to access data about items for sale, seller reviews, customer reviews, and product promotions on all Amazon marketplaces worldwide. Basic API...

PHP-FIG Alternatives: The Pros and Cons of Various Visions

Posted on: No Comments
In his article The Past, Present and Future of the PHP-FIG, Larry Garfield gives a whirlwind tour of his impressions of the FIG, from its founding to one of its possible futures. I encourage you to read it in its entirety before continuing. Herein, I w...

Design and Build Your Own JavaScript Library: Tips & Tricks

This article was peer reviewed by Adrian Sandu, Vildan Softic and Dan Prince. Thanks to all of SitePoint's peer reviewers for making SitePoint content the best it can be! Libraries: we use them all the time. A library is packaged code that developers c...

Contributing to PHP: How to Contribute to PHP’s Manual

In this two-part article series, we’ll be covering how to contribute to the PHP project. This will hopefully clarify what steps need to be taken for those looking to become more involved with PHP. This first part will be covering how to contribute to...

Learn PHP 7, Find out What’s New, and More

Posted on: No Comments
PHP 7, the next version of the world’s most popular programming language, has been released. We’d love to shoot fireworks and get drunk with our newfound power (seriously, the language is in the true big leagues now, functionality and performance-w...

The Importance of Writing Code That Humans Can Read

Posted on: No Comments
Have you ever finished a project in a single run without ever needing to look at the code again? Neither have I. When working on an older project, you probably want to spend little to no time figuring out how code works. Readable code is imperative to ...

Fast Multi-language Docs with SitePoint’s RTDSphinx-PHP

Posted on: No Comments
This post will guide you through getting up and running with RTDSphinx-PHP, a ReadTheDocs-friendly Sphinx based PHP documentation skeleton with sane defaults, pre-installed directives, and modified styles for optimal API and prose documentation renderi...

Using Sphinx for PHP Project Documentation

Posted on: No Comments
I recently had the need to write proper prose-like source-code documentation for the Diffbot PHP client. Having looked at several documentation generators, and even having suggested a @prose tag for importing of related MD/reST documents into method an...