Skip to main content

Missing documentation, a way for one developer to insult another developer

Missing documentation, a way for one developer to insult another developer

Setting up a "Hello World" project should never be a nightmare, but time and again I run into instances where a "Getting Started" project has a invisible "requirement", or steps which are not documented or they are assumed to be must know even before a "hello world" sample project.

My expectations for "Getting Started" is, it should contain entire step by step instructions. Strangely some developers while writing documentations, skip the requirement altogether and others link to documentation manual with no clear indication as to after landing on the fifty page document, one is suppose to read.

Why has it become a mandatory approach of developers, that because I suffered, others who follow in my foot steps should also suffer. It feels like as a web developer we are yet to evolve.

It was interesting to hear about the perspective from one of the colleague that, not having complete documentation is like insulting; from one developer to the other.

It's true, why should we make another developer suffer or use the brain power, on something that could have been written down. It's a net loss, for other developer to ask the owner of the sample or git project for for help. Then others researching and finding the solution to help out. If there is no financial benefit in hiding the information they why hold on to it?

If there is an action to be performed, then document it. Take a screenshot if necessary and make life easy of the fellow developer or new comer to the programming field.

Stop insulting each other, document the entire process.


Popular posts from this blog

Completed UiPath - RPA Developer Advance Training

After a month of training, with late nights and weekends I have completed the UiPath RPA Developer Advance Training. The Level 1 Foundation Training pretty much covered all the basics of Desktop studio and workflows, only draw back was I started with the default foundation course which was for 2016, and all document reference links where pointing to 2016 version. I didn't understand it during the foundation training and kept switching to 2018 version document/page. Only after completing the Foundation course that I realized, I was suppose to have started with the 2018 version of Level 1 Foundation Training, but as it was optional I didn't have to retake the 2018 version, the 2016 was good enough for moving to level 2. The Level 2 Orchestrator 2018.3 Training as good. It gave good understanding of Queue's, Jobs, and schedules and I was able to complete the level two much faster then the level 1. The Level 3 UiPath Advanced Training was bit tough as it involved the a

KB 294807 - IIS Server - PHP FastCGI 500 Error 0xfffffffe

Resolved issue today of IIS Server - PHP FastCGI 500 Error 0xfffffffe by deleting "Windows Temp" folder files. We used Cygwin to customize some permissions of "Windows Temp" folder and after few hours the website stopped working. The search online was giving all kinds of different solution except what I was looking for. I was hoping the stackoverflow will have answers but even this post didn't cover the issue I was running into. Restarting the IIS didn't work, but deleting temp files cleared the issue, but now the problem is how long before the site will go down again? Hope the issue is resolved for ever, if not; I will update this post later.

QlikSense - Custom Form Login Screen

Extension of:  Custom login, logout and error forms for Qlik Sense by RPK QlikSense - Custom Login Screen Install Node on QlikSense Server: URL: Saved at: C:\server-tools\Downloads\Node Installed at: C:\server-tools\Runtime\nodejs\ Keep default options Create Folder: C:\QlikForm Clone git Repository and keep updates private: # Open Shell/Bash/Command Prompt cd /QlikForm # Ref: git clone --bare .git cd QS-Custom-Forms.git git push --mirror<name>/QS-Custom-Forms.git cd .. (go to parent folder) # remove other users repo clone rm -rf QS-Custom-Forms.git # clone witinc private repo git clone<name>/QS-Custom-Forms.git Get latest copy of login pages: # Open She