{"id":48301,"date":"2020-04-10T09:08:45","date_gmt":"2020-04-10T07:08:45","guid":{"rendered":"https:\/\/mamchenkov.net\/wordpress\/?p=48301"},"modified":"2020-04-10T09:08:45","modified_gmt":"2020-04-10T07:08:45","slug":"a-practical-guide-to-writing-technical-specs","status":"publish","type":"post","link":"https:\/\/mamchenkov.net\/wordpress\/2020\/04\/10\/a-practical-guide-to-writing-technical-specs\/","title":{"rendered":"A practical guide to writing technical specs"},"content":{"rendered":"<!-- google_ad_section_start -->\n<p>Writing technical specifications is difficult.\u00a0 Writing good technical specifications is even more so.\u00a0 Here&#8217;s an excellent <a href=\"https:\/\/stackoverflow.blog\/2020\/04\/06\/a-practical-guide-to-writing-technical-specs\/\">practical guide from StackOverflow on how to write technical specifications<\/a>, which have everything needed, yet not being too excessive or vague.<\/p>\n<p>In the comments, there are a few additional suggestions and links to other similar guides.<\/p>\n<p>The only way this could have been better, if they included a ready-made template with all the described sections, so that one could just fill it in and be done with it.<\/p>\n<!-- google_ad_section_end -->\n","protected":false},"excerpt":{"rendered":"<!-- google_ad_section_start -->\n<p>Writing technical specifications is difficult.\u00a0 Writing good technical specifications is even more so.\u00a0 Here&#8217;s an excellent practical guide from StackOverflow on how to write technical specifications, which have everything needed, yet not being too excessive or vague. In the comments, there are a few additional suggestions and links to other similar guides. The only way &hellip; <a href=\"https:\/\/mamchenkov.net\/wordpress\/2020\/04\/10\/a-practical-guide-to-writing-technical-specs\/\" class=\"more-link\">Continue reading <span class=\"screen-reader-text\">A practical guide to writing technical specs<\/span><\/a><\/p>\n<!-- google_ad_section_end -->\n","protected":false},"author":2,"featured_media":0,"comment_status":"open","ping_status":"open","sticky":false,"template":"","format":"standard","meta":{"_monsterinsights_skip_tracking":false,"_monsterinsights_sitenote_active":false,"_monsterinsights_sitenote_note":"","_monsterinsights_sitenote_category":0,"_jetpack_memberships_contains_paid_content":false,"footnotes":"","jetpack_publicize_message":"","jetpack_publicize_feature_enabled":true,"jetpack_social_post_already_shared":true,"jetpack_social_options":{"image_generator_settings":{"template":"highway","default_image_id":0,"font":"","enabled":false},"version":2},"_links_to":"","_links_to_target":""},"categories":[1,62,1334],"tags":[3069,78,3178,3435,1330],"keyring_services":[],"class_list":["post-48301","post","type-post","status-publish","format-standard","hentry","category-general","category-technology","category-web-work","tag-best-practices","tag-documentation","tag-project-management","tag-stackoverflow","tag-web-development"],"aioseo_notices":[],"jetpack_publicize_connections":[],"jetpack_featured_media_url":"","jetpack-related-posts":[{"id":42500,"url":"https:\/\/mamchenkov.net\/wordpress\/2019\/04\/13\/stackoverflow-developer-survey-results-2019\/","url_meta":{"origin":48301,"position":0},"title":"StackOverflow: Developer Survey Results 2019","author":"Leonid Mamchenkov","date":"April 13, 2019","format":false,"excerpt":"This year's results for StackOverflow Developer Survey are in. This is probably the largest survey of IT professionals, with nearly 90,000 participating this year. As always, there are plenty of insightful findings and correlations in the results. But one that I was somewhat glad to see was the attitude towards\u2026","rel":"","context":"In &quot;All&quot;","block_context":{"text":"All","link":"https:\/\/mamchenkov.net\/wordpress\/category\/general\/"},"img":{"alt_text":"","src":"https:\/\/i0.wp.com\/mamchenkov.net\/wordpress\/wp-content\/uploads\/2019\/04\/blockchain-work.png?resize=350%2C200&ssl=1","width":350,"height":200,"srcset":"https:\/\/i0.wp.com\/mamchenkov.net\/wordpress\/wp-content\/uploads\/2019\/04\/blockchain-work.png?resize=350%2C200&ssl=1 1x, https:\/\/i0.wp.com\/mamchenkov.net\/wordpress\/wp-content\/uploads\/2019\/04\/blockchain-work.png?resize=525%2C300&ssl=1 1.5x"},"classes":[]},{"id":26269,"url":"https:\/\/mamchenkov.net\/wordpress\/2016\/07\/21\/the-regex-that-killed-stackoverflow\/","url_meta":{"origin":48301,"position":1},"title":"The RegEx that killed StackOverflow","author":"Leonid Mamchenkov","date":"July 21, 2016","format":false,"excerpt":"Here's an outage postmortem from the recent StackOverflow downtime. \u00a0It just shows you how easy it is to break things, even they were built by some of the smartest people around. \u00a0Programming is touch and there is no way around it. Technical Details The regular expression was: ^[\\s\\u200c]+|[\\s\\u200c]+$ Which is\u2026","rel":"","context":"In &quot;All&quot;","block_context":{"text":"All","link":"https:\/\/mamchenkov.net\/wordpress\/category\/general\/"},"img":{"alt_text":"","src":"","width":0,"height":0},"classes":[]},{"id":26978,"url":"https:\/\/mamchenkov.net\/wordpress\/2016\/11\/27\/on-coping-from-stackoverflow\/","url_meta":{"origin":48301,"position":2},"title":"On copying from StackOverflow","author":"Leonid Mamchenkov","date":"November 27, 2016","format":false,"excerpt":"Geek and poke does it again ... this time on the subject of copying code from StackOverflow:","rel":"","context":"In &quot;All&quot;","block_context":{"text":"All","link":"https:\/\/mamchenkov.net\/wordpress\/category\/general\/"},"img":{"alt_text":"stackoverflow","src":"https:\/\/i0.wp.com\/mamchenkov.net\/wordpress\/wp-content\/uploads\/2016\/11\/stackoverflow-353x500.jpg?resize=350%2C200&ssl=1","width":350,"height":200},"classes":[]},{"id":27307,"url":"https:\/\/mamchenkov.net\/wordpress\/2017\/02\/09\/the-most-mentioned-books-on-stackoverflow\/","url_meta":{"origin":48301,"position":3},"title":"The Most Mentioned Books On StackOverflow","author":"Leonid Mamchenkov","date":"February 9, 2017","format":false,"excerpt":"Slashdot links to \"The Most Mentioned Books On StackOverflow\". How we did it: We got database dump of all user-contributed content on the Stack Exchange network (can be downloaded here) Extracted questions and answers made on stackoverflow Found all amazon.com links and counted it Created tag-based search for your convenience\u2026","rel":"","context":"In &quot;All&quot;","block_context":{"text":"All","link":"https:\/\/mamchenkov.net\/wordpress\/category\/general\/"},"img":{"alt_text":"","src":"https:\/\/i0.wp.com\/mamchenkov.net\/wordpress\/wp-content\/uploads\/2017\/02\/stackoverflow-books-500x133.png?resize=350%2C200&ssl=1","width":350,"height":200},"classes":[]},{"id":28555,"url":"https:\/\/mamchenkov.net\/wordpress\/2018\/05\/07\/stack-overflow-for-teams-is-now-available\/","url_meta":{"origin":48301,"position":4},"title":"Stack Overflow for Teams is Now Available","author":"Leonid Mamchenkov","date":"May 7, 2018","format":false,"excerpt":"StackOverflow, the greatest online resource for developers, has announced the availability of the StackOverflow for Teams.\u00a0 This is a spin off service which allows developer teams to run private instances of StackOverflow for knowledge and information sharing needed for non-public projects. This sounds like a great tool to replace a\u2026","rel":"","context":"In &quot;All&quot;","block_context":{"text":"All","link":"https:\/\/mamchenkov.net\/wordpress\/category\/general\/"},"img":{"alt_text":"","src":"https:\/\/i0.wp.com\/mamchenkov.net\/wordpress\/wp-content\/uploads\/2018\/05\/StackOverflow-Teams-446x500.png?resize=350%2C200&ssl=1","width":350,"height":200},"classes":[]},{"id":22182,"url":"https:\/\/mamchenkov.net\/wordpress\/2014\/07\/12\/migrating-twitter-bootstrap-2-3-2-to-3-0\/","url_meta":{"origin":48301,"position":5},"title":"Migrating Twitter Bootstrap 2.3.2 to 3.0","author":"Leonid Mamchenkov","date":"July 12, 2014","format":false,"excerpt":"For those of us who are starting to look into Twitter Bootstrap 3.0\u00a0 for new projects and possible migration of old projects from Twitter Bootstrap 2.3.2 to 3.0, I found a couple of good resources. \u00a0 Firstly, this very brief StackOverflow discussion on what has changed between the versions. \u00a0And\u2026","rel":"","context":"In &quot;All&quot;","block_context":{"text":"All","link":"https:\/\/mamchenkov.net\/wordpress\/category\/general\/"},"img":{"alt_text":"","src":"","width":0,"height":0},"classes":[]}],"jetpack_sharing_enabled":true,"amp_enabled":true,"_links":{"self":[{"href":"https:\/\/mamchenkov.net\/wordpress\/wp-json\/wp\/v2\/posts\/48301","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/mamchenkov.net\/wordpress\/wp-json\/wp\/v2\/posts"}],"about":[{"href":"https:\/\/mamchenkov.net\/wordpress\/wp-json\/wp\/v2\/types\/post"}],"author":[{"embeddable":true,"href":"https:\/\/mamchenkov.net\/wordpress\/wp-json\/wp\/v2\/users\/2"}],"replies":[{"embeddable":true,"href":"https:\/\/mamchenkov.net\/wordpress\/wp-json\/wp\/v2\/comments?post=48301"}],"version-history":[{"count":0,"href":"https:\/\/mamchenkov.net\/wordpress\/wp-json\/wp\/v2\/posts\/48301\/revisions"}],"wp:attachment":[{"href":"https:\/\/mamchenkov.net\/wordpress\/wp-json\/wp\/v2\/media?parent=48301"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/mamchenkov.net\/wordpress\/wp-json\/wp\/v2\/categories?post=48301"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/mamchenkov.net\/wordpress\/wp-json\/wp\/v2\/tags?post=48301"},{"taxonomy":"keyring_services","embeddable":true,"href":"https:\/\/mamchenkov.net\/wordpress\/wp-json\/wp\/v2\/keyring_services?post=48301"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}