ExportXMLWordPrintableJSON

    • Type: Spec Change
    • Resolution: Done
    • Priority: Major - P3
    • None
    • Component/s: Cross Spec Consistency
    • None
    • Not Needed

      Summary

      What is the problem or use case, what are we trying to achieve?

      Current drivers specifications are not consistently standardized and vary widely in formatting, grammar, writing style, and structure. This makes reviews more subjective, slower, and generally inconsistent depending on who is reviewing and for what.

      Motivation

      Who is the affected end user?

      Who are the stakeholders?

      Drivers engineers.

      How does this affect the end user?

      Are they blocked? Are they annoyed? Are they confused?

      Inconsistent specifications and reviews.

      How likely is it that this problem or use case will occur?

      Main path? Edge case?

      Most spec changes.

      If the problem does occur, what are the consequences and how severe are they?

      Minor annoyance at a log message? Performance concern? Outage/unavailability? Failover can't complete?

      Slow drift in specification formatting and style that leads to larger inconsistencies. Inconsistent standards for reviewers.

      Is this issue urgent?

      Does this ticket have a required timeline? What is it?

      This quarter.

      Is this ticket required by a downstream team?

      Needed by e.g. Atlas, Shell, Compass?

      No.

      Is this ticket only for tests?

      Does this ticket have any functional impact, or is it just test improvements?

      Neither, process improvements.

      Acceptance Criteria

      What specific requirements must be met to consider the design phase complete?

      • A CONTRIBUTING.md document in the specifications repo with specific, agreed-upon standards for specification documents.

            Assignee:
            Noah Stapp
            Reporter:
            Noah Stapp
            Noah Stapp Noah Stapp
            Votes:
            0 Vote for this issue
            Watchers:
            1 Start watching this issue

              Created:
              Updated:
              Resolved: