Code Reviews & Documentation

DevOps, CI/CD & ToolingTopic 2 of 155 questions

Q1Operational documentation a production service needs: README, runbooks, troubleshooting guides, deployment docs, architecture diagrams

Operational documentation turns 'ask the person who built it' into 'follow the page,' which is the difference between a five-minute recovery and a five-hour outage.

Read Answer

Q2How to do code / PR reviews

A good review verifies requirement, quality, correct business logic, error handling, performance, security, tests, and standards -- catching defects early and spreading knowledge.

Read Answer

Q3How to ensure the quality and maintainability of your code

Quality and maintainability come from clean code, standards, tests, reviews, docs, modular design, CI/CD, and continuous refactoring working together.

Read Answer

Q4Why sizing ZGC in a container needs more headroom than G1: and why -Xmx at ~70-75% of the pod limit, not ~90%

Heap is not the whole footprint; ZGC needs extra concurrent and native headroom, so set -Xmx to about 70-75% of the pod limit, because 90% gets you OOM-killed mid-GC.

Read Answer

Q5Architecture Decision Records (ADR) and technical RFCs: what they are and why version-control them

An ADR records one settled decision with its trade-offs; an RFC proposes a bigger change for feedback first; version-controlling both makes decisions traceable and stops endless re-debate.

Read Answer