Hacktoberfest 2026: những issue maintainer đã đánh dấu cho tháng Mười, đang mở và phù hợp người mới. Xem issue Hacktoberfest

Create the Architectual Decision Record (ADR) process

Đang mở
  • Có gì không ổn?
#414 2 bình luận 0 reaction 0 người được giao Xem trên GitHub

Maintainer thường phản hồi trong vòng 1 ngày

Chưa có ai nhận issue này.

Đánh giá

Độ khó
5/5
Thời gian dự kiến
Hơn một tuần
Mức phù hợp với người mới
35/100
Loại issue
Tài liệu
Độ rõ ràng
Khá rõ ràng
Mức độ hoạt động
Ít trao đổi
Lĩnh vực
documentation

Hướng nghiên cứu

Bắt đầu bằng việc đọc issue #413 và hướng dẫn ADR GitHub Organisation được liên kết; không có tệp repository hoặc test nào được nêu. Xác định các công cụ ADR, artifact, thư mục lưu trữ, quy ước và quy trình, sau đó tạo ba ADR ví dụ và ghi lại cách các team có thể tìm và viết chúng. Công việc được xem là hoàn thành khi các tiêu chí chấp nhận được đáp ứng và quy trình đã được chia sẻ với các team khác.

Do mô hình lập chỉ mục viết ra từ nội dung của issue.

Mô tả

documentation enhancement P3 - Normal (TTR: 1 month) process documentation

Overview

As a documentation contributor, I want the context for information architecture decisions, So I can understand the intent.

As a documentation maintainer, I want to know how to create information architecture records, So I can share them with stakeholders when necessary.

Description

As described by the ADR Github Organisation:

An Architectural Decision (AD) is a justified design choice that addresses a functional or non-functional requirement that is architecturally significant. An Architecturally Significant Requirement (ASR) is a requirement that has a measurable effect on the architecture and quality of a software and/or hardware system. An Architectural Decision Record (ADR) captures a single AD and its rationale; Put it simply, ADR can help you understand the reasons for a chosen architectural decision, along with its trade-offs and consequences

Within the context of NGINX documentation, ADRs will be used to record decisions for a given information architecture pattern, but will likely expand to cover other decisions with large impact, such as style guide or design system approaches.

The process for these decisions is covered by issue https://github.com/nginx/documentation/issues/413: a GitHub discussion with a specific timebox, with creating an ADR as a next step.

Creating ADRs will be an ongoing task, so the focus of this issue is to define the process for managing ADRs, then socialising their existence.

Tasks

  • Decide the tools or artifacts that will be necessary for ADRs
  • Create a folder in GitHub for storing ADRs
  • Create three ADRs to show examples of the convention
  • Share the ADRs and process with other teams

Acceptance criteria

  • The user can understand what an ADR is
  • The user has clear guidance on where to find ADRs
  • The user can match any given documentation pattern to an ADR
  • The user is able to write their own ADR with process artifacts (Templates, guidance).
Ngôn ngữ chính
HTML
Star
97
Fork
176
Merge trung bình
1 ngày 14 giờ
Pull request đã merge (30 ngày)
63

Chuẩn bị môi trường

Bắt đầu từ đâu

  1. Đọc hết issue, rồi đọc hướng dẫn đóng góp của dự án.
  2. Bình luận trên issue rằng bạn sẽ nhận — tránh hai người làm cùng một việc.
  3. Fork repository và làm thay đổi trên một nhánh.
  4. Mở pull request có tham chiếu số hiệu của issue.

Issue khác của nginx/documentation

Tất cả issue của nginx/documentation

Issue tương tự

Thêm issue về Documentation

Nhận issue mới trong hộp thư của bạn

Bản tóm tắt ngắn những issue GitHub phù hợp với người mới.