ci(docs): 문서 검사에 문체를 더하고 번역한 결정 기록의 머리 문구를 맞춘다

문체 규칙(「~한다」, 「~합니다」와 섞지 않음)은 docs/README.md에 있지만
지키는 검사가 없어서, 번역 뒤에도 runbook 열 개에 높임 문장이 남았다.
그리고 결정 기록 머리 블록의 둘째 줄은 「본문은 결정한 때의 원문이다」인데,
2026-11-07에 본문을 한국어로 옮긴 ADR에는 맞지 않는다.

- check-docs.py `style`: 살아 있는 문서의 문장 끝이 높임(습니다·합니다·
  입니다·됩니다·십시오·하세요·주세요)이면 실패. 코드 블록, 인라인 코드,
  따옴표·낫표 안 인용, 「이력」 인용 블록은 보지 않는다.
- runbook 열 개의 「이 runbook은 다음 alert에서 발동됩니다.」를 「다음 alert가
  울리면 쓴다.」로 고쳤다. 지금 걸리는 곳은 이것뿐이었다.
- 결정 기록 표시 줄을 「본문은 결정한 때의 내용이다(번역은 뜻을 바꾸지
  않았다)」로 바꿨다: check-docs.py의 DECISION_LABEL, docs/README.md 설명,
  docs/adr의 머리 블록 33개(기록은 머리 블록만 고친다는 규칙 안).
- docs/README.md 「문서 검사」에 앞 커밋이 더한 `link`와 이번 `style`을 적고,
  링크 검사 설명을 바로잡았다. 「모듈 README」 절(design-docs
  docs-system.md 6.2절 다섯 칸)을 더했다.

버린 대안: 문체를 리뷰로만 보기(번역 묶음 네 개를 거쳐도 남았다).

위험: design-docs docs-system.md 4.1절과 프론트의 같은 문구는 이 repo
밖이라 고치지 않았다(총괄에게 알린다).

검증: python3 -m unittest discover -s scripts/tests(문체 시험 5 포함),
check-docs.py, check-work-docs.py 모두 rc=0. 이 커밋의 트리만 얹은 임시
worktree에서 돌렸다. 검사 조건을 끈 사본 둘에서 문체 시험이 각각 2건,
1건 실패했다.
This commit is contained in:
DongHyeonka
2026-11-07 22:20:18 +09:00
parent 37c88fedd4
commit 59dff0041c
44 changed files with 128 additions and 47 deletions
+26
View File
@@ -471,6 +471,32 @@ class LinkTest(RepositoryTestCase):
self.assertEqual(self.repo.run(("link",)), [])
class StyleTest(RepositoryTestCase):
def errors_for(self, text: str, path: str = "docs/guide.md") -> list[str]:
self.repo.write(path, KOREAN + text)
return self.repo.run(("style",))
def test_a_polite_sentence_fails(self) -> None:
self.assertFailsWith(self.errors_for("이 runbook은 다음 alert에서 발동됩니다.\n"), "높임 문체다")
def test_a_polite_request_at_the_end_of_a_line_fails(self) -> None:
self.assertFailsWith(self.errors_for("- 설정을 바꾼 뒤 다시 실행하세요\n"), "…하세요")
def test_the_plain_style_passes(self) -> None:
self.assertEqual(self.errors_for("이 runbook은 다음 alert가 울리면 쓴다.\n"), [])
def test_quoted_code_and_history_mentions_are_skipped(self) -> None:
text = ("문체는 「~한다」다. 「~합니다」와 섞지 않는다.\n"
"응답 본문은 \"요청을 처리할 수 없습니다.\"다. `처리합니다.`는 코드다.\n"
"```json\n{\"message\": \"처리할 수 없습니다.\"}\n```\n"
"> 이력: 이 문서는 예전에 「~합니다」로 썼습니다.\n")
self.assertEqual(self.errors_for(text), [])
def test_a_record_is_not_checked(self) -> None:
self.repo.write("docs/design/2026-08-11-x-design.md", head() + "이 설계는 채택되었습니다.\n")
self.assertEqual(self.repo.run(("style",)), [])
class CommandLineTest(unittest.TestCase):
def test_an_unknown_check_is_a_usage_error(self) -> None:
self.assertEqual(check_docs.main(["--only", "spelling"]), 2)