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

https://storify.com/willianmeador/alternatives-to-getting-links-without-guest-bloggi
https://medium.com/@willianmeador/how-to-maximize-online-sites-as-a-marketing-tool-2707facb52e7
https://josefjacksblog.wordpress.com/2017/07/06/off-page-seo-tactics-to-remember-for-building-traffic-and-gaining-authority/
http://josefjacks.over-blog.com/2017/07/tactics-for-boosting-search-engine-marketing.html
https://www.flickr.com/photos/150790841@N04/35710146506/
https://www.flickr.com/photos/156549103@N02/35364014660/
https://denisgainey.tumblr.com/post/162703822106/how-to-effectively-respond-to-negative-reviews
https://irwinsigler.wordpress.com/2017/07/04/how-to-promote-your-brand-internationally/
https://sites.google.com/view/optimize-snippets/
http://19-myblog-92.blogspot.com/2017/07/some-ways-to-revive-falling-organic.html
https://damionhutcherson.wordpress.com/2017/07/07/how-to-make-the-kids-love-exercising/
http://adriftwithnowheretogo.blogspot.com/2017/07/how-to-stop-yelling-at-your-kid.html
https://sites.google.com/view/relationship-with-your-kid/
https://denisgainey.wordpress.com/2017/07/10/how-bad-it-is-to-show-your-anger-to-the-child/
https://storify.com/hiltoncallaway/how-to-control-yelling
http://jasperspooner.over-blog.com/2017/07/right-way-and-occasion-to-apologize-to-your-child.html
https://sites.google.com/view/relationship-with-children/
https://jasperspooner.wordpress.com/2017/07/11/how-to-be-influential-as-parent/
https://sites.google.com/view/homework-habits-in-children/
https://sites.google.com/view/manage-anger-at-the-child/
http://audiosdopb.blogspot.com/2017/07/how-to-deal-with-tantrums-in-park.html
https://storify.com/jasperspooner/is-it-right-to-negotiate-with-the-children
http://ajifotoclick.blogspot.com/2017/07/how-to-perfect-your-parenting-style.html
http://dbloggerstar.blogspot.com/2017/07/the-effects-of-bite-force-on-dentures.html
https://sites.google.com/view/oral-health-and-breast-cancer/
http://bingohelpdesk.blogspot.com/2017/07/how-to-combat-tooth-sensitivity.html
http://areugiddy.blogspot.com/2017/07/will-pill-ever-keep-dentist-away.html
https://storify.com/linwoodpenn/obesity-and-gum-disease
http://asakura-onsen.blogspot.com/2017/07/why-sedation-dentistry-helps-you-fight.html
https://nathanaelbusby.wordpress.com/2017/07/12/options-for-missing-teeth/
https://linwoodpenn.wordpress.com/2017/07/07/why-bacteria-makes-a-difference-in-gum-disease/
http://rebelliouz11.blogspot.com/2017/07/the-risk-of-sleep-apnea.html
https://storify.com/damiondoughty/what-molar-incisor-hypomineralization-is
https://sites.google.com/view/sweetening-alternates/
https://storify.com/newtonduggan/why-chewing-fights-infection
https://linwoodpenn.tumblr.com/post/162700237643/why-fluoride-works
https://willianmeador.wordpress.com/2017/07/04/how-bitewing-x-ray-is-more-advantageous-in-maintaining-dental-health/
http://crazy-bout-pkmn.blogspot.com/2017/07/dental-crowns-and-their-types.html
http://cubanbrother.blogspot.com/2017/07/why-should-you-get-replacement-options.html
https://www.behance.net/gallery/54693707/All-About-Nicotine-Stomatitis
https://www.behance.net/gallery/54429615/How-to-Reduce-Braces-pain
https://carlohowerton.wordpress.com/2017/07/12/reasons-you-should-consult-the-dentist/
https://sites.google.com/view/reduce-tooth-sensitivity/
http://alain-r-comix.blogspot.com/2017/07/all-about-frenum-and-types-of-it.html
http://anamericanquilt.blogspot.com/2017/07/things-you-want-to-know-about-dental.html
https://medium.com/@carlohowerton/going-to-the-dentist-when-you-are-sick-3ebfa43390f2
https://storify.com/carlohowerton/can-invisalign-cause-allergic-reactions
http://carlohowerton.over-blog.com/2017/07/reasons-for-some-common-dental-practices.html
http://denisgainey.over-blog.com/2017/07/what-porcelain-veneers-can-do-for-you.html
http://aserasanthropophorum.blogspot.com/2017/07/how-pregnancy-complicates-sleep-apnea.html
https://medium.com/@denisgainey/how-to-find-the-best-dentist-for-you-d204682b3e05
http://rraveneye.blogspot.com/2017/07/why-dental-implants-are-easier-than-ever.html
https://sites.google.com/view/how-indigestion-impacts/
http://bexzamilth.blogspot.com/2017/07/radiographs-in-dentistry.html
https://damiondoughty.wordpress.com/2017/07/12/types-of-finger-rests-and-fulcrums-for-maxillary-teeth/
https://lonnypepper.wordpress.com/2017/07/12/why-invisalign-rocks/
https://sites.google.com/view/get-stress-out-of-moving-days/
http://cdfcdiz.blogspot.com/2017/07/efficient-and-effective-dorm-room.html
http://aesthetics-deco.blogspot.com/2017/07/packing-dishes-properly-before-moving.html
http://carlasague.blogspot.com/2017/07/five-essential-packing-materials-for.html
http://willianmeador.over-blog.com/2017/07/tips-for-moving-electronic-items.html
http://designyourlife2009.blogspot.com/2017/07/the-musts-of-packing-books-for-moving.html
https://storify.com/josefjacks/stress-free-favor-boxes-and-weddings
http://biblofertas.blogspot.com/2017/07/shrink-wrap-it-up-ill-take-it.html
http://delegacionleonesamontanismo.blogspot.com/2017/07/stretch-wrap-smart-way-to-ship.html
http://boltactionparatodos.blogspot.com/2017/07/5-shapes-and-uses-of-folding-carton.html

Using free weights is a time tested method of improving fitness. Weight can be adjusted to the individual's needs, for maximum workout effectiveness. Although they can be dangerous to someone using them by themselves, they have been proven to work. As long as you are using the proper technique, you can improve your fitness with free weights.

As you begin to recover from a painful muscle injury or strain, gradually increase the intensity and duration of your recovery workout rather than jumping right back into your previous workout routine. After each Male Extra Reviews workout, apply ice to the injured area for half an hour, then repeat the process with added intensity the next day.

Assignment writing is complicated assignment for college students. Our experts are available in cheap rate for Get Good Marks in assignment writing to support students to complete their assignment on given time and also help them in achieving higher grade in academic career. hire now by Student Assignment Help.

Add new comment