Giter VIP home page Giter VIP logo

Comments (4)

joelparkerhenderson avatar joelparkerhenderson commented on August 25, 2024

Yes your question makes sense. How's this rewrite?

Characteristics of good "Consequences" section in an ADR:

  • Explain what follows from making the decision. This can include the effects, outcomes, outputs, follow ups, and more.

  • Include information about any subsequent ADRs. It's relatively common for one ADR to trigger the need for more ADRs, such as when one ADR makes a big overarching choice, which in turn creates needs for more smaller decisions.

  • Include any after-action review processes. It's typical for teams to review each ADR one month later, to compare the ADR information with what's happened in actual practice, in order to learn and grow.

from architecture-decision-record.

Philzen avatar Philzen commented on August 25, 2024

Sounds lovely, everything in this rewrite makes perfect sense to me ❤️

Absolutely no confusion here.

When i read though the examples, they don't have a "Consequences" section, but do list implications – things that need to be sorted out as a consequence of the decision.

So my only suggestion could be to add the word "implications" (either next to "Consequences" or in the first bullet point), but in generally i think your rewrite makes a great improvement.

Thanks for your quick response!

from architecture-decision-record.

Philzen avatar Philzen commented on August 25, 2024

(keeping this open just in case you want to track the change commit to-do, feel free to close anytime)

from architecture-decision-record.

Philzen avatar Philzen commented on August 25, 2024

Even though it doesn't say anything on implications, i can see 28be671 added your suggested improvements, hence closing this issue.

Thanks 👍

from architecture-decision-record.

Related Issues (16)

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.