Technical documents should be reviewed by technical people

Just recently, I was implementing a protocol at work. The protocol was handed to me in the form of a Word document and it appeared to have already cleared some approval stages. The protocol seemed over-engineered to me. It used HTTP POST with XML in the request and response bodies. There was actually only one message type and it seemed like it could have easily been implemented with a simple GET request and no response body (just an HTTP response with a proper response code). The document was 24 pages long when it only required 1. It had about 10 error response message types, about half of which had to do with XML errors. I looked at who reviewed the document and it was as follows:

  • Author: Engineering Manager
  • Reviewer: VP Engineering
  • Reviewer: Technical Director
  • Reviewer: Director of Engineering, Client Engineering
  • Reviewer: Director of Engineering, Host and Infrastructure Engineering
  • Reviewer: Engineering Manager, Quality Engineering

Missing are Principal Engineers and most importantly, Senior Developers, like myself, who will be implementing the protocol. It's not even necessary to consult the people who will be implementing the protocol, but you need to consult with people who understand HTTP, have experience with using web protocol, and an understanding of programming. One of those listed above qualifies in that respect, but that is still just one person. I am sure that if this was shown to three other people who aren't managers, directors, or VPs, they would say this protocol is over-engineered. If even one person thinks it's over-engineered, and over-engineering things is costly. It adds complexity on both sides of the protocol which means more development, more bugs, more testing. There's no excuse for over-engineering things and not excuse not to have technical documents revealed by those who will implement, the hands-on technical people.

Comments

Current world scenario belongs to techno-age where everyone requires the fastest gadgets and applications to work on. QuickBooks fulfills the all the requirements of the users in accounting field so if the users have any problem related to it they can reach out us on QuickBooks customer support number +1-855-861-4161 to resolve their all issues.

Norton.com/setup Online Help: – Step by Step guide for Norton Setup, Download & complete installation online. We are providing independent support service if in case you face problem to activate or Setup Norton product.

Mcafee.com/activate Online Help – Step by Step guide for McAfee Activate, Download & complete installation online. We are providing independent support service if in case you face problem to activate or Activate McAfee product. Just fill the form below and will get in touch with you as quick as possible.

office.com/setup Online Help – Step by Step guide for office Setup, Download & complete installation online. We are providing independent support service if in case you face problem to activate or Setup office product.

Great  post, you have pointed out some  fantastic  points , I  likewise  think  this s a very  wonderful website

Parc Life

We provide excellent Windows 8 tech support services to the clients. To get the help of our professionals call us at Windows 8 support toll free number 1-888-827-9060.

QuickBooks accounting software has been widely used across the world.Quickbooks download, installation, update and other errors.To get more details of Our Quickbooks Toll Free Number just call us at: US:1-888-827-9060, UK:0-800-368-7372 (Toll Free)

TurboTax provides free one-on-one guidance and complete support in the unlikely event of an audit. You can easily download it on your desktop or can use its mobile application.All you need to do is call us at our TurboTax toll-free number 1-888-827-9060. Your call will get connected in less than 60 seconds.

Quicken the most trusted and easy financial management software has transformed the lives of millions of consumers.To get more details of our Quicken support Services just call us at: US: 1-888-827-9060 & UK: 0-800-368-7372 (Toll Free).

Office Setup is the full suite of Microsoft productivity software that combines a variety of applications, services, and server like Excel, PowerPoint, Word, OneNote, Publisher and Access.Office.com/Setup Step-by-Step guide for office setup,Downlaod & Complete installation Online if sometime you face any problem to activate and install office setup via contact uswww.office.com/setup1-888-827-9060

Pogo is an online gaming portal with more than 100 casual games from the most renowned brands Hasbro and PopCap Games.If you want to more about pogo game via To get more details of our Pogo Support Services just call us at: US:1-888-827-9060, UK:0-800-368-7372 (Toll Free).

QuickBooks accounting software has been widely used across the world.Quickbooks download, installation, update and other errors can easy to understand.To get more details of Our Quickbooks Toll Free Number just call us at: US:1-888-827-9060, UK:0-800-368-7372 (Toll Free)

TurboTax provides free one-on-one guidance and complete support in the unlikely event of an audit. You can easily download it on your desktop or can use its mobile application.All you need to do is call us at our TurboTax toll-free number 1-888-827-9060.

office.com/setup Online Help – Step by Step guide for office Setup, Download & complete installation online. We are providing independent support service if in case you face problem to activate or Setup office product.office.com/setup

norton.com/setup Online Help – Step by Step guide for Norton Setup, Download & complete installation online. We are providing independent support service if in case you face problem to activate or Setup Norton product.

norton.com/setup

I was perusing your article and thought about whether you had considered making a digital book on this subject. You"re composing would offer it quick. You have a considerable measure of composing ability. outsource software

mcafee.com/activate Online Help – Step by Step guide for McAfee Activate, Download & complete installation online. We are providing independent support service if in case you face problem to activate or Activate McAfee product. Just fill the form below and will get in touch with you as quick as possible.mcafee.com/activate

mcafee.com/activate
Online Help – Step by Step guide for McAfee Activate, Download & complete installation online. We are providing independent support service if in case you face problem to activate or Activate McAfee product. Just fill the form below and will get in touch with you as quick as possible.

mcafee.com/activate Online Help :– Step by Step guide for McAfee Activate, Download & complete installation online. We are providing independent support service if in case you face problem to activate or Activate McAfee product. Just fill the form below and will get in touch with you as quick as possible.

Mowgli (Neel Sethi) who was raised since his birth in the middle of the wolves was made to leave the jungle due to a fearsome tiger Shere Khan, who consistently remained after him to attack. showbox app

Thanks for this article. It contains the information i was searching for and you have also explained it well. We are also a service provider that deal in the assignment writing help sector. So, the students struggling to write their college assignments can opt for our online assignment help UKand can get a quality assignment written from us.

QuickBooks accounting software has been widely used across the world.You can easily download, installation and update this software.To get more details of Our Quickbooks Technical Support just call us at: US:1-888-827-9060, UK:0-800-368-7372 (Toll Free) and also follow Quickbook Support website link.

This software is always up-to-date with the latest tax laws, which ensures its accuracy and reliability.TurboTax provides free one-on-one guidance and complete support.To get more details of our Turbotax Technical Support services just call us at: US: 1-888-827-9060 & UK: 0-800-368-7372 (Toll Free).

Pages

Add new comment