troubleshooting cookiecuter

troubleshooting is always a repetitive process that can be automated

  • document
    • steps to reproduce the issue
    • the environment
      • products
      • versions
      • data
  • automate
    • each step can be automated
    • build utilities for yourself or the end user

inputs

cookiecutter.json

{
    product: "product",
    feature: "feature",
    broke: "broke",
    title: "product-feature-broke-how",
    input-one: "default-value",
    input-two: "default-value",
    input-three: "default-value",
    input-four: "default-value",
    input-five: "default-value",
    ...
}

documentation output

readme.md

# {{cookiecutter.project}}

## instructions

{{cookiecutter.input-one}}
product: "product",
    feature: "feature",
    broke: "broke",
    title: "product-feature-broke-how",
    input-one: "default-value",
    input-two: "default-value",
    input-three: "default-value",
    input-four: "default-value",
    input-five: "default-value",

conversation

here you can put text snippets because you're going to repeat the same type of questions for any troubleshooting

they really only vary a tiny bit and the conversation should be consistent from person to person

```text questions for the end user?

Comments