How to Write Awesome Tech Specs by Lyft Engineering

2-3 sentences describing the who/what/when/where/why of your entire project.

Expected outcomes, both objective and subjective.

What intentionally are you not doing? Define and limit the scope.

The longest section of the spec, level of detail depending on audience. Describe the engineering approach, include architectural diagrams.

What metrics will you use to measure whether this project met its intended goal?

What are potential risks and how are you mitigating them?

Other approaches you considered but decided against and why.

Break the project out into intermediate milestones with estimated dates.

Unresolved questions you are still working through and need feedback on.

Learn how to write comprehensive tech specifications with this helpful document. It provides a step-by-step framework including sections on background, goals, plan, measuring impact, security, privacy considerations, and more. Ensure your project is clear

Tech Specification

silviu

Bogdan_test

ferwhethgte

target1

google

test

support

product_name

specific

var_miha

new_var_2

new_mih_var

mih_var

This is a plain text that will be inserted in an expandable heading for using this raw as an exampl

testheight

available

testulet

testvar

altscenario

This is a plain text that will be inserted in an expandable heading for using this raw as an example

scenario

exemplu

variabila

Archbee

text

refresh_token

Docker cheatsheet

Check out the custom blocks that come with Archbee

docs.archbee.com/demo

Launch checklist

Client Kickoff

Meeting Notes

Project Proposal

Project Retrospective

Post mortem

Investor Letter

Quarterly OKRs

Monthly Sales Recap

Marketing styleguides

User persona

Competitor watch

Social Media Policy

Marketing project

SEO Checklist

ARCHBEE TEMPLATES

Retrieve Transaction Summary

Account Balance

Retrieve All Members.

Add Members

Edit License Levels

Retrieve Groups Assigned to an Account

Create Account Group

Unassign Account from Subscription

Unassign Account

Edit User Role

Retrieve Applicable Account Groups

Edit Account Group

Retrieve Invites

Invite to Account Group

Resend Invites

Accept Invites

Amend Invite

Retrieve All Subscriptions

Add Member to Subscription

Account Groups

Retrieve an accounts subscriptions

Initiate a subscription purchase

Complete an asynchronous subscription purchase

Update the renewal status of a subscription

Update Subscription Attributes

Add a voucher to a subscription

Change the subscription service.

/api/accounts/{accountReference}/subscriptions/{subscriptionReference}/moves

/api/accounts/{accountReference}/subscriptions/{subscriptionReference}/moves/{optionType}

Account Subscriptions

Trigger a forgotten password email

Link an account to a Yahoo Japan, Facebook, Google or Jahrain account

Verify an email address

Retrieve all accounts

Create account

Update password via email token

Authenticate via email

Authenticate via ClientUserId (Third Party)

Authenticate via an external SSO provider

Create an account via third-party

Retrieve account

Delete account

Update an account.

Trigger email verification

Replicate iTunes subscription within eSuite

Replicate Roku subscription within eSuite

Replicate Amazon subscription within eSuite

Replicate Google subscription within eSuite

Retrieve available external providers

Assign an existing subscription to a group

Accounts

Untitled

Create address

Retrieve address

Delete address

Addresses

Retrieve analytics information

Analytics

Bulk add entitlements

Bulk Entitlements

Retrieve Bundles for the affiliate

Creates a Bundle for the affiliate

Retrieve a Bundle by reference

Allows a bundle to be deleted for an affiliate

Updates the properties of a bundle

Deletes a product from the specified bundle

Allows adding products to a pre defined bundle

Allows adding contract frequencies to be attached to a bundle

Updates the pricing for a product in a bundle

Deletes a contract from the specified bundle

Bundles

Create Cart

Retrieve Cart

Delete Cart

Update Cart

Create Line item

Delete Line item

Validate voucher against a cart

Add a voucher to a cart

Retrieve an accounts cart

Carts

Retrive all support logs

Create a support log

Retrieve a support log

Delete a support log

Edit a support log

Customer Support Log

Encodes an identifier from its composite pieces

Decodes an idenfier into a numeric value

Dev Tools

Get the client device policies

Insert a client device policy

Update a client device policy

Delete a client device policy

Get the account device policies

Insert an account device policy

Update an account device policy

Register a device

Updates a device

Deletes a device

Registers a slot

Check a slot

Releases a slot

Device Policy

Retrieve Entitlements

Create an entitlement

Validate access for an entitlement

Delete an entitlement

Entitlements

Retrieve a fulfilment for an account

Update a fulfilment

Create additional fulfilment payment

Retrieve all fulfilments for an account

Fulfilment

Creates a gift code and sends it to the recipient

Gifting

Create account and replicate iTunes subscriptions

Create account and replicate Roku subscriptions

Create account if it does not exist, if it exists authenticate account and create a subscription in the system for the service provided in the request object

Tech Specification

Summary

Background

Goals

Non-goals

Plan

Measuring Impact

Security, Privacy, Risks

Other Considerations

Milestones

Open Questions