Be part of JetBrains PHPverse 2026 on June 9 – a free online event bringing PHP devs worldwide together.

jekinney's avatar

What seems to be missing

I have read a lot of the topics here and what seems, to me, to be lacking is planning and documentation. I know that many times tutorials on line and for that matter programming books lack this topic.

Unless I am trying out a quick feature I never start coding with out documenting what I am trying to accomplish. This helps narrow the scope of the project, sets my features I will implement and more importantly little frustrating tidbits like name spacing, folder layout and custom functions. This helps reduce issues while coding and running into that blankness while trying to think of what to name a method or function, file or class.

As a former ASP.net developer the term modular design is big, in PHP it is similar to a package (like Way's Generators, Commander, etc). Modular design is what I utilize with Laravel, This allows me to use the same, or similar user system in each of my projects. Client wants a blog system added? No problem, I have that all set right here. Just drag a few files in set up the bindings, views and psr-4 auto loading. Done.

Utilizing the code to an interface, it doesn't matter what database the client is using, plug, quick configure and play. Easy money.

Utilizing the documentation and a flat file system (I try to never have more then 3 files deep in namespaces, which also helps to reduce ftp drag and drop issues on a slow host issues) I or anyone can read where each class is what what is its purpose with out having to dive in to the production code to figure it out.

Obviously working on a team where each member is coding a specific feature this is mandatory standard operating procedure to ensure no conflicts with names and data tables etc. I would argue this should be a part of any developers practice. We all can write beautiful code, but why can't we document worth a crap?

A lot of questions here I keep thinking about if the person had written some of it out before coding the question could have been answered before hand and thus allow for reduced frustration while coding and hitting that stumbling block.

0 likes
0 replies

Please or to participate in this conversation.