Category: documentation

MDN Product Advisory Board

We all know and love MDN for already being the best documentation for web features out there. It looks like it’s poised to get even better with Google and Microsoft both joining a new board. Mozilla’s vision for the MDN Product Advisory Board is to build collaboration that helps the MDN community collective...

PHPBot – Can a PHP Bot Help You Look up Documentation Faster?

I came across PHPBot the other day (not to be confused with Botman or Fondbot) – a “chatbot” which helps you look up PHP manual entries and generates example code for them. If you follow me on Twitter, you know I don’t believe in chatbots being chatbots – as someone who’s built some ...

What Does a Well-Documented CSS Codebase Look Like?

In the front-end community, there is a lot of attention related to documenting JavaScript. That’s not so much the case with CSS. Often times I feel like lost when I join a project with minimal or no CSS documentation. Even though CSS is relatively easy to write, it can be quite hard to maintain. The specificity, ...

The Balance between Visual and Technical Debt in PHP

Laracasts recently published a very interesting non-Laravel video about something called visual debt. It’s only 3 minutes long, so please, take the time to watch it before reading further. Done? Okay, spoilers below. In the video, Jeff starts out with with a bit of verbose event-based code with some listeners, ...

PDS Skeleton by Example: A Standard for File and Folder Structure

Looking at the Packagist registry, we can see that most packages follow a pattern, with some small changes to fit their needs, while others have a weird folder structure that takes time to get your head around. This problem has been solved in different ways by different people. Some frameworks have their own recommend...

On Writing Feature Requirements

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 organizing my thoughts. I’ve written an executive summary f...

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

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 Concepts When working with the API, the first th...

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

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 will attempt to address some of the errors and omissions in LarryR...

Disco with Design Patterns: A Fresh Look at Dependency Injection

Dependency Injection is all about code reusability. It’s a design pattern aiming to make high-level code reusable, by separating the object creation / configuration from usage. Consider the following code: <?php class Test { protected $dbh; public function __construct(PDO $dbh) { ...

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 can use in their projects, which invariably saves work and prev...