A Practical Guide To Writing Technical Specs

[TOC]

https://stackoverflow.blog/2020/04/06/a-practical-guide-to-writing-technical-specs/?utm_source=Iterable&utm_medium=email&utm_campaign=the_overflow_newsletter

Contents of a technical spec

There are a wide range of problems being solved by a vast number of companies today. Each organization is distinct and creates its own unique engineering culture. As a result, technical specs may not be standard even within companies, divisions, teams, and even among engineers on the same team. Every solution has different needs and you should tailor your technical spec based on the project. You do not need to include all the sections mentioned below. Select the sections that work for your design and forego the rest.

From my experience, there are seven essential parts of a technical spec: front matter, introduction, solutions, further considerations, success evaluation, work, deliberation, and end matter.

1. Front matter

• Title
• Author(s)
• Team
• Reviewer(s)
• Created on
• Last updated
• Epic, ticket, issue, or task tracker reference link

2. Introduction

a. Overview, Problem Description, Summary, or Abstract

• Summary of the problem (from the perspective of the user), the context, suggested solution, and the stakeholders.

b. Glossary or Terminology

• New terms you come across as you research your design or terms you may suspect your readers/stakeholders not to know.

c. Context or Background

• Reasons why the problem is worth solving
• Origin of the problem
• How the problem affects users and company goals
• Past efforts made to solve the solution and why they were not effective
• How the product relates to team goals, OKRs
• How the solution fits into the overall product roadmap and strategy
• How the solution fits into the technical strategy

d. Goals or Product and Technical Requirements

• Product requirements in the form of user stories
• Technical requirements

e. Non-Goals or Out of Scope

• Product and technical requirements that will be disregarded

f. Future Goals

• Product and technical requirements slated for a future time

g. Assumptions

• Conditions and resources that need to be present and accessible for the solution to work as described.

Solutions

a. Current or Existing Solution / Design

• Current solution description
• Pros and cons of the current solution

b. Suggested or Proposed Solution / Design

• External components that the solution will interact with and that it will alter
• Dependencies of the current solution
• Pros and cons of the proposed solution
• Data Model / Schema Changes
  • Schema definitions
  • New data models
  • Modified data models
  • Data validation methods
• Business Logic
  • API changes
  • Pseudocode
  • Flowcharts
  • Error states
  • Failure scenarios
  • Conditions that lead to errors and failures
  • Limitations
• Presentation Layer
  • User requirements
  • UX changes
  • UI changes
  • Wireframes with descriptions
  • Links to UI/UX designer’s work
  • Mobile concerns
  • Web concerns
  • UI states
  • Error handling
• Other questions to answer
  • How will the solution scale?
  • What are the limitations of the solution?
  • How will it recover in the event of a failure?
  • How will it cope with future requirements?

c. Test Plan

• Explanations of how the tests will make sure user requirements are met
• Unit tests
• Integrations tests
• QA

d. Monitoring and Alerting Plan

• Logging plan and tools
• Monitoring plan and tools
• Metrics to be used to measure health
• How to ensure observability
• Alerting plan and tools

e. Release / Roll-out and Deployment Plan

• Deployment architecture
• Deployment environments
• Phased roll-out plan e.g. using feature flags
• Plan outlining how to communicate changes to the users, for example, with release notes

f. Rollback Plan

• Detailed and specific liabilities
• Plan to reduce liabilities
• Plan describing how to prevent other components, services, and systems from being affected

g. Alternate Solutions / Designs

• Short summary statement for each alternative solution
• Pros and cons for each alternative
• Reasons why each solution couldn’t work
• Ways in which alternatives were inferior to the proposed solution
• Migration plan to next best alternative in case the proposed solution falls through

Further Considerations

a. Impact on other teams

• How will this increase the work of other people?

b. Third-party services and platforms considerations

• Is it really worth it compared to building the service in-house?
• What are some of the security and privacy concerns associated with the services/platforms?
• How much will it cost?
• How will it scale?
• What possible future issues are anticipated?

c. Cost analysis

• What is the cost to run the solution per day?
• What does it cost to roll it out?

d. Security considerations

• What are the potential threats?
• How will they be mitigated?
• How will the solution affect the security of other components, services, and systems?

e. Privacy considerations

• Does the solution follow local laws and legal policies on data privacy?
• How does the solution protect users’ data privacy?
• What are some of the tradeoffs between personalization and privacy in the solution?

f. Regional considerations

• What is the impact of internationalization and localization on the solution?
• What are the latency issues?
• What are the legal concerns?
• What is the state of service availability?
• How will data transfer across regions be achieved and what are the concerns here?

g. Accessibility considerations

• How accessible is the solution?
• What tools will you use to evaluate its accessibility?

h. Operational considerations

• Does this solution cause adverse aftereffects?
• How will data be recovered in case of failure?
• How will the solution recover in case of a failure?
• How will operational costs be kept low while delivering increased value to the users?

i. Risks

• What risks are being undertaken with this solution?
• Are there risks that once taken can’t be walked back?
• What is the cost-benefit analysis of taking these risks?

j. Support considerations

• How will the support team get across information to users about common issues they may face while interacting with the changes?
• How will we ensure that the users are satisfied with the solution and can interact with it with minimal support?
• Who is responsible for the maintenance of the solution?
• How will knowledge transfer be accomplished if the project owner is unavailable?

Success Evaluation

a. Impact

• Security impact
• Performance impact
• Cost impact
• Impact on other components and services

b. Metrics

• List of metrics to capture
• Tools to capture and measure metrics

Work

a. Work estimates and timelines

• List of specific, measurable, and time-bound tasks
• Resources needed to finish each task
• Time estimates for how long each task needs to be completed

b. Prioritization

• Categorization of tasks by urgency and impact

c. Milestones

• Dated checkpoints when significant chunks of work will have been completed
• Metrics to indicate the passing of the milestone

d. Future work

• List of tasks that will be completed in the future

Deliberation

a. Discussion

• Elements of the solution that members of the team do not agree on and need to be debated further to reach a consensus.

b. Open Questions

• Questions about things you do not know the answers to or are unsure that you pose to the team and stakeholders for their input. These may include aspects of the problem you don’t know how to resolve yet.

End Matter

a. Related Work

• Any work external to the proposed solution that is similar to it in some way and is worked on by different teams. It’s important to know this to enable knowledge sharing between such teams when faced with related problems.

b. References

• Links to documents and resources that you used when coming up with your design and wish to credit.

c. Acknowledgments

• Credit people who have contributed to the design that you wish to recognize.

• 上一篇 完美转发
• 下一篇 More c++ idioms