[문서 관리] README·에이전트 지침·LAN 안내로 문서 축소 #16

New Issue

2026-11-04T11:31:42+09:00

dekim2 commented

2026-11-04 11:31:42 +09:00

에이전트가 매번 읽는 프로젝트 MD를 README, AGENTS, LAN 안내로 줄이고 작업 맥락은 이슈 제목으로 검색합니다.

README.md: 실행 명령, 화면 진입점, 데이터 갱신과 이슈 검색 안내.
AGENTS.md: 필요한 파일만 읽는 원칙, 원본 보존, 작업·검증을 이슈에 기록하는 규칙.
docs/lan-sharing.md: 공유 주소, WSL/Windows 전달, 방화벽, 장애 복구와 원복 절차를 유지합니다.
기존 문서 전문과 참고자료 안내는 로컬 docs/history.txt로 통합해 원래 파일명으로 검색할 수 있게 보존합니다.
공유 IP와 내부 네트워크 설정은 로컬 LAN 문서에 보존하며 이슈 본문에 복사하지 않습니다.
자동 분석 보고서는 docs/analysis.txt에 생성하도록 기본 경로를 변경해 MD가 다시 늘어나지 않게 합니다.

이 기록은 문서 구조 변경이며 앱 기능·네트워크 설정 변경이 아닙니다. 원본 도면·입력·생성 데이터는 업로드하지 않습니다.

에이전트가 매번 읽는 프로젝트 MD를 README, AGENTS, LAN 안내로 줄이고 작업 맥락은 이슈 제목으로 검색합니다. - `README.md`: 실행 명령, 화면 진입점, 데이터 갱신과 이슈 검색 안내. - `AGENTS.md`: 필요한 파일만 읽는 원칙, 원본 보존, 작업·검증을 이슈에 기록하는 규칙. - `docs/lan-sharing.md`: 공유 주소, WSL/Windows 전달, 방화벽, 장애 복구와 원복 절차를 유지합니다. - 기존 문서 전문과 참고자료 안내는 로컬 `docs/history.txt`로 통합해 원래 파일명으로 검색할 수 있게 보존합니다. - 공유 IP와 내부 네트워크 설정은 로컬 LAN 문서에 보존하며 이슈 본문에 복사하지 않습니다. - 자동 분석 보고서는 `docs/analysis.txt`에 생성하도록 기본 경로를 변경해 MD가 다시 늘어나지 않게 합니다. 이 기록은 문서 구조 변경이며 앱 기능·네트워크 설정 변경이 아닙니다. 원본 도면·입력·생성 데이터는 업로드하지 않습니다.

dekim2 commented

2026-11-04 11:34:14 +09:00

로컬 문서 정리를 완료했습니다.

프로젝트 MD를 14개에서 3개(README, AGENTS, LAN 안내)로 줄였습니다.
기존 14개 문서 전문은 원래 경로와 SHA256을 붙여 docs/history.txt에 보존했고, 이동 전 백업도 .local/documentation-before-2026-11-04/에 보존했습니다. 보관본과 자동 분석 TXT는 Git 제외 대상입니다.
LAN 안내는 작업 시작 시 내용과 바이트 단위로 동일합니다. 공유 주소·설정·복구·원복 절차를 유지했습니다.
주제별 기록 #11~#15를 등록하고 닫았습니다. README에서 제목 검색어와 이슈 링크를 안내합니다.
SWMM 파서의 기본 보고서 경로를 docs/analysis.txt로 변경했습니다.

검증: 파서 회귀 검사 python3 -B -m unittest discover -s tests -p 'test_parser.py' -v 7개 통과. 임시 출력 폴더에서 실제 원본 파싱 후 기본 TXT 생성·MD 미생성·원본 해시 보존을 확인했습니다. MD 개수·로컬 문서 링크·14개 보관본 해시·LAN 원문 일치와 git diff --check를 확인했습니다. 브라우저 검사는 이번 문서 정리에서 재실행하지 않았습니다.

로컬 변경은 커밋·푸시하지 않았습니다. 기존 애플리케이션 미커밋 변경도 유지했습니다.

로컬 문서 정리를 완료했습니다. - 프로젝트 MD를 14개에서 3개(README, AGENTS, LAN 안내)로 줄였습니다. - 기존 14개 문서 전문은 원래 경로와 SHA256을 붙여 `docs/history.txt`에 보존했고, 이동 전 백업도 `.local/documentation-before-2026-11-04/`에 보존했습니다. 보관본과 자동 분석 TXT는 Git 제외 대상입니다. - LAN 안내는 작업 시작 시 내용과 바이트 단위로 동일합니다. 공유 주소·설정·복구·원복 절차를 유지했습니다. - 주제별 기록 #11~#15를 등록하고 닫았습니다. README에서 제목 검색어와 이슈 링크를 안내합니다. - SWMM 파서의 기본 보고서 경로를 `docs/analysis.txt`로 변경했습니다. 검증: 파서 회귀 검사 `python3 -B -m unittest discover -s tests -p 'test_parser.py' -v` 7개 통과. 임시 출력 폴더에서 실제 원본 파싱 후 기본 TXT 생성·MD 미생성·원본 해시 보존을 확인했습니다. MD 개수·로컬 문서 링크·14개 보관본 해시·LAN 원문 일치와 `git diff --check`를 확인했습니다. 브라우저 검사는 이번 문서 정리에서 재실행하지 않았습니다. 로컬 변경은 커밋·푸시하지 않았습니다. 기존 애플리케이션 미커밋 변경도 유지했습니다.

dekim2 closed this issue

2026-11-04 11:34:15 +09:00

Sign in to join this conversation.

1 Participants

Notifications

Due Date

No due date set.

Dependencies

No dependencies set.

Reference: dekim2/hwacheon-network-viewer#16