이 문서는 현재 작성된 T2Editor 문서 세트의 내부 링크 구조를 전수 점검한 결과를 기록합니다. 이번 검수의 목표는 다음 네 가지였습니다.
related_docs 값이 실제 파일명과 맞는지 확인related_docs 검사 결과: 깨진 참조 0건.md 파일명 참조 검사 결과: 존재하지 않는 파일 참조 0건아래 문서는 본문에 다른 문서 파일명이 일반 텍스트 또는 코드 표기 형태로만 적혀 있어, 클릭 가능한 상대경로 링크로 바꿨습니다.
각 문서의 상단 메타데이터 중 related_docs 항목을 확인했습니다. 검사 기준은 다음과 같습니다.
.md 파일명인지.md를 붙이면 실제 파일이 존재하는지현재 세트에서는 related_docs 기준으로 깨진 참조는 발견되지 않았습니다.
본문 안에서 다음과 같은 형식의 문서 참조를 검사했습니다.
00-overview-macro-guide.mdcore-editor-lib-php.mdplugin-ai.mddirectory-plugin-guide.md이 가운데 존재하지 않는 파일명은 발견되지 않았습니다. 다만 일부 문서는 파일명을 코드 표기만 하고 링크로 연결하지 않아 탐색성이 떨어졌습니다. 이번에 그 부분을 상대경로 링크로 보완했습니다.
현재 내부 링크는 깨지지 않지만, 아래 부분은 앞으로 더 보완할 수 있습니다.
두 문서가 모두 개발자 진입 성격을 띠고 있어 제목만 보면 혼동할 수 있습니다. 다음 개정 때는 하나는 “빠른 진입”, 다른 하나는 “심층 구조 진입”처럼 역할을 더 명확하게 나누는 편이 좋습니다.
related_docs는 잘 연결되어 있으나, 본문의 “관련 문서” 섹션이 있는 문서와 없는 문서의 편차가 있습니다. 다음 정리 단계에서는 모든 문서에 공통 형식으로 아래 섹션을 넣는 것이 좋습니다.
앞으로는 다른 문서를 언급할 때 아래 형식 중 하나로 통일하는 것이 좋습니다.
파일명.md` 또는 실제 파일 링크 형식이 원칙을 지키면 검색 허브와 별개로 폴더 브라우징만 하더라도 문서 간 이동이 훨씬 쉬워집니다.
related_docs를 이용해 자동 “관련 문서” 블록을 렌더링하는 허브 기능 추가이 보고서는 현재 문서 세트를 기준으로 작성되었으며, 이후 파일명 변경이나 문서 추가가 발생하면 다시 점검해야 합니다.
이 문서는 현재 작성된 T2Editor 문서 세트의 내부 링크 구조를 전수 점검한 결과를 기록합니다. 이번 검수의 목표는 다음 네 가지였습니다.
related_docs 값이 실제 파일명과 맞는지 확인related_docs 검사 결과: 깨진 참조 0건.md 파일명 참조 검사 결과: 존재하지 않는 파일 참조 0건아래 문서는 본문에 다른 문서 파일명이 일반 텍스트 또는 코드 표기 형태로만 적혀 있어, 클릭 가능한 상대경로 링크로 바꿨습니다.
각 문서의 상단 메타데이터 중 related_docs 항목을 확인했습니다. 검사 기준은 다음과 같습니다.
.md 파일명인지.md를 붙이면 실제 파일이 존재하는지현재 세트에서는 related_docs 기준으로 깨진 참조는 발견되지 않았습니다.
본문 안에서 다음과 같은 형식의 문서 참조를 검사했습니다.
00-overview-macro-guide.mdcore-editor-lib-php.mdplugin-ai.mddirectory-plugin-guide.md이 가운데 존재하지 않는 파일명은 발견되지 않았습니다. 다만 일부 문서는 파일명을 코드 표기만 하고 링크로 연결하지 않아 탐색성이 떨어졌습니다. 이번에 그 부분을 상대경로 링크로 보완했습니다.
현재 내부 링크는 깨지지 않지만, 아래 부분은 앞으로 더 보완할 수 있습니다.
두 문서가 모두 개발자 진입 성격을 띠고 있어 제목만 보면 혼동할 수 있습니다. 다음 개정 때는 하나는 “빠른 진입”, 다른 하나는 “심층 구조 진입”처럼 역할을 더 명확하게 나누는 편이 좋습니다.
related_docs는 잘 연결되어 있으나, 본문의 “관련 문서” 섹션이 있는 문서와 없는 문서의 편차가 있습니다. 다음 정리 단계에서는 모든 문서에 공통 형식으로 아래 섹션을 넣는 것이 좋습니다.
앞으로는 다른 문서를 언급할 때 아래 형식 중 하나로 통일하는 것이 좋습니다.
파일명.md` 또는 실제 파일 링크 형식이 원칙을 지키면 검색 허브와 별개로 폴더 브라우징만 하더라도 문서 간 이동이 훨씬 쉬워집니다.
related_docs를 이용해 자동 “관련 문서” 블록을 렌더링하는 허브 기능 추가이 보고서는 현재 문서 세트를 기준으로 작성되었으며, 이후 파일명 변경이나 문서 추가가 발생하면 다시 점검해야 합니다.
| 이전 | 새 버전 | ||
|---|---|---|---|
| 1 | --- | 1 | --- |
| 2 | title: 내부 링크 검수 보고서 | 2 | title: 내부 링크 검수 보고서 |
| 3 | document_id: 80-internal-link-audit-report | 3 | document_id: 80-internal-link-audit-report |
| 4 | slug: 80-internal-link-audit-report | 4 | slug: 80-internal-link-audit-report |
| 5 | target_editor_version: 9.0.0 | 5 | target_editor_version: 9.0.0 |
| 6 | document_type: maintenance | 6 | document_type: maintenance |
| 7 | doc_type: maintenance | 7 | doc_type: maintenance |
| 8 | target_readers: [웹마스터, 개발자, AI agent] | 8 | target_readers: [웹마스터, 개발자, AI agent] |
| 9 | importance: Medium | 9 | importance: Medium |
| 10 | dependency: Low | 10 | dependency: Low |
| 11 | core_type: Non-Core | 11 | core_type: Non-Core |
| 12 | stability: [Stable Anchor] | 12 | stability: [Stable Anchor] |
| 13 | stable_anchor: [문서 파일명, related_docs, 상대경로 링크] | 13 | stable_anchor: [문서 파일명, related_docs, 상대경로 링크] |
| 14 | version_bound: [] | 14 | version_bound: [] |
| 15 | related_docs: [00-overview-macro-guide.md, 73-external-reference-index.md, 99-audit-and-remediation-report.md] | 15 | related_docs: [00-overview-macro-guide.md, 73-external-reference-index.md, 99-audit-and-remediation-report.md] |
| 16 | related_files: [] | 16 | related_files: [] |
| 17 | related_functions: [] | 17 | related_functions: [] |
| 18 | related_classes_modules: [] | 18 | related_classes_modules: [] |
| 19 | related_features: [문서 허브, 내부 링크, 문서 참조] | 19 | related_features: [문서 허브, 내부 링크, 문서 참조] |
| 20 | related_ui: [] | 20 | related_ui: [] |
| 21 | change_risk: 링크 경로를 잘못 수정하면 문서 허브와 개별 문서 탐색성이 떨어질 수 있습니다. | 21 | change_risk: 링크 경로를 잘못 수정하면 문서 허브와 개별 문서 탐색성이 떨어질 수 있습니다. |
| 22 | reading_order: 80 | 22 | reading_order: 80 |
| 23 | summary: 현재 문서 세트의 내부 링크와 문서 간 참조를 점검한 결과와 수정 내역을 정리한 보고서입니다. | 23 | summary: 현재 문서 세트의 내부 링크와 문서 간 참조를 점검한 결과와 수정 내역을 정리한 보고서입니다. |
| 24 | description: 모든 Markdown 문서의 related_docs와 본문 내 파일명 참조를 점검해 존재하지 않는 내부 링크가 있는지 확인하고, 클릭 가능한 상대경로 링크로 보완한 내역을 기록합니다. | 24 | description: 모든 Markdown 문서의 related_docs와 본문 내 파일명 참조를 점검해 존재하지 않는 내부 링크가 있는지 확인하고, 클릭 가능한 상대경로 링크로 보완한 내역을 기록합니다. |
| 25 | tags: [T2Editor, internal-link, audit, maintenance, docs] | 25 | tags: [T2Editor, internal-link, audit, maintenance, docs] |
| 26 | version_tag: 9.0.0 | 26 | version_tag: 9.0.0 |
| 27 | maintenance_difficulty: Low | 27 | maintenance_difficulty: Low |
| 28 | test_requirement: Medium | 28 | test_requirement: Medium |
| 29 | ai_agent_risk: Low | 29 | ai_agent_risk: Low |
| 30 | source_basis: [현재 코드 분석 기반] | 30 | source_basis: [현재 코드 분석 기반] |
| 31 | beginner_section_included: false | 31 | beginner_section_included: false |
| 32 | webmaster_section_included: true | 32 | webmaster_section_included: true |
| 33 | developer_section_included: true | 33 | developer_section_included: true |
| 34 | --- | 34 | --- |
| 35 | 35 | ||
| 36 | # 내부 링크 검수 보고서 | 36 | # 내부 링크 검수 보고서 |
| 37 | 37 | ||
| 38 | 이 문서는 현재 작성된 T2Editor 문서 세트의 **내부 링크 구조를 전수 점검**한 결과를 기록합니다. | 38 | 이 문서는 현재 작성된 T2Editor 문서 세트의 **내부 링크 구조를 전수 점검**한 결과를 기록합니다. |
| 39 | 이번 검수의 목표는 다음 네 가지였습니다. | 39 | 이번 검수의 목표는 다음 네 가지였습니다. |
| 40 | 40 | ||
| 41 | 1. 문서 front matter의 `related_docs` 값이 실제 파일명과 맞는지 확인 | 41 | 1. 문서 front matter의 `related_docs` 값이 실제 파일명과 맞는지 확인 |
| 42 | 2. 본문 안에서 다른 문서를 언급할 때 깨진 상대경로가 없는지 확인 | 42 | 2. 본문 안에서 다른 문서를 언급할 때 깨진 상대경로가 없는지 확인 |
| 43 | 3. 단순 파일명 텍스트로만 적혀 있어 클릭할 수 없던 참조를 실제 내부 링크로 보완 | 43 | 3. 단순 파일명 텍스트로만 적혀 있어 클릭할 수 없던 참조를 실제 내부 링크로 보완 |
| 44 | 4. 중복되거나 헷갈릴 수 있는 문서 간 참조가 최소한 상호 이동 가능하도록 정리 | 44 | 4. 중복되거나 헷갈릴 수 있는 문서 간 참조가 최소한 상호 이동 가능하도록 정리 |
| 45 | 45 | ||
| 46 | ## 검수 결과 요약 | 46 | ## 검수 결과 요약 |
| 47 | 47 | ||
| 48 | - 총 검사 문서 수: 64개 | 48 | - 총 검사 문서 수: 64개 |
| 49 | - front matter `related_docs` 검사 결과: **깨진 참조 0건** | 49 | - front matter `related_docs` 검사 결과: **깨진 참조 0건** |
| 50 | - 본문 내 `.md` 파일명 참조 검사 결과: **존재하지 않는 파일 참조 0건** | 50 | - 본문 내 `.md` 파일명 참조 검사 결과: **존재하지 않는 파일 참조 0건** |
| 51 | - 클릭 불가능한 파일명 표기 보완: **4개 문서 수정** | 51 | - 클릭 불가능한 파일명 표기 보완: **4개 문서 수정** |
| 52 | - 신규 보고서 문서 추가: **1개** | 52 | - 신규 보고서 문서 추가: **1개** |
| 53 | 53 | ||
| 54 | ## 실제 수정한 문서 | 54 | ## 실제 수정한 문서 |
| 55 | 55 | ||
| 56 | 아래 문서는 본문에 다른 문서 파일명이 일반 텍스트 또는 코드 표기 형태로만 적혀 있어, 클릭 가능한 상대경로 링크로 바꿨습니다. | 56 | 아래 문서는 본문에 다른 문서 파일명이 일반 텍스트 또는 코드 표기 형태로만 적혀 있어, 클릭 가능한 상대경로 링크로 바꿨습니다. |
| 57 | 57 | ||
| 58 | - [08-developer-architecture-entry.md](08-developer-architecture-entry.md) | 58 | - [08-developer-architecture-entry.md](08-developer-architecture-entry.md) |
| 59 | - [09-developer-architecture-entry.md](09-developer-architecture-entry.md) | 59 | - [09-developer-architecture-entry.md](09-developer-architecture-entry.md) |
| 60 | - [72-version-issues-guide.md](72-version-issues-guide.md) | 60 | - [72-version-issues-guide.md](72-version-issues-guide.md) |
| 61 | - [99-audit-and-remediation-report.md](99-audit-and-remediation-report.md) | 61 | - [99-audit-and-remediation-report.md](99-audit-and-remediation-report.md) |
| 62 | 62 | ||
| 63 | ## 검수 기준 | 63 | ## 검수 기준 |
| 64 | 64 | ||
| 65 | ### 1. front matter 기준 | 65 | ### 1. front matter 기준 |
| 66 | 각 문서의 상단 메타데이터 중 `related_docs` 항목을 확인했습니다. | 66 | 각 문서의 상단 메타데이터 중 `related_docs` 항목을 확인했습니다. |
| 67 | 검사 기준은 다음과 같습니다. | 67 | 검사 기준은 다음과 같습니다. |
| 68 | 68 | ||
| 69 | - 같은 폴더에 실제 존재하는 `.md` 파일명인지 | 69 | - 같은 폴더에 실제 존재하는 `.md` 파일명인지 |
| 70 | - 확장자가 빠진 경우 `.md`를 붙이면 실제 파일이 존재하는지 | 70 | - 확장자가 빠진 경우 `.md`를 붙이면 실제 파일이 존재하는지 |
| 71 | - 파일명이 중간에 변경된 흔적이 없는지 | 71 | - 파일명이 중간에 변경된 흔적이 없는지 |
| 72 | 72 | ||
| 73 | 현재 세트에서는 `related_docs` 기준으로 깨진 참조는 발견되지 않았습니다. | 73 | 현재 세트에서는 `related_docs` 기준으로 깨진 참조는 발견되지 않았습니다. |
| 74 | 74 | ||
| 75 | ### 2. 본문 기준 | 75 | ### 2. 본문 기준 |
| 76 | 본문 안에서 다음과 같은 형식의 문서 참조를 검사했습니다. | 76 | 본문 안에서 다음과 같은 형식의 문서 참조를 검사했습니다. |
| 77 | 77 | ||
| 78 | - `00-overview-macro-guide.md` | 78 | - `00-overview-macro-guide.md` |
| 79 | - `core-editor-lib-php.md` | 79 | - `core-editor-lib-php.md` |
| 80 | - `plugin-ai.md` | 80 | - `plugin-ai.md` |
| 81 | - `directory-plugin-guide.md` | 81 | - `directory-plugin-guide.md` |
| 82 | 82 | ||
| 83 | 이 가운데 존재하지 않는 파일명은 발견되지 않았습니다. | 83 | 이 가운데 존재하지 않는 파일명은 발견되지 않았습니다. |
| 84 | 다만 일부 문서는 파일명을 **코드 표기만 하고 링크로 연결하지 않아** 탐색성이 떨어졌습니다. 이번에 그 부분을 상대경로 링크로 보완했습니다. | 84 | 다만 일부 문서는 파일명을 **코드 표기만 하고 링크로 연결하지 않아** 탐색성이 떨어졌습니다. 이번에 그 부분을 상대경로 링크로 보완했습니다. |
| 85 | 85 | ||
| 86 | ## 아쉬운 점과 후속 보완 제안 | 86 | ## 아쉬운 점과 후속 보완 제안 |
| 87 | 87 | ||
| 88 | 현재 내부 링크는 깨지지 않지만, 아래 부분은 앞으로 더 보완할 수 있습니다. | 88 | 현재 내부 링크는 깨지지 않지만, 아래 부분은 앞으로 더 보완할 수 있습니다. |
| 89 | 89 | ||
| 90 | ### 중복 성격 문서 | 90 | ### 중복 성격 문서 |
| 91 | - [08-developer-architecture-entry.md](08-developer-architecture-entry.md) | 91 | - [08-developer-architecture-entry.md](08-developer-architecture-entry.md) |
| 92 | - [09-developer-architecture-entry.md](09-developer-architecture-entry.md) | 92 | - [09-developer-architecture-entry.md](09-developer-architecture-entry.md) |
| 93 | 93 | ||
| 94 | 두 문서가 모두 개발자 진입 성격을 띠고 있어 제목만 보면 혼동할 수 있습니다. | 94 | 두 문서가 모두 개발자 진입 성격을 띠고 있어 제목만 보면 혼동할 수 있습니다. |
| 95 | 다음 개정 때는 하나는 “빠른 진입”, 다른 하나는 “심층 구조 진입”처럼 역할을 더 명확하게 나누는 편이 좋습니다. | 95 | 다음 개정 때는 하나는 “빠른 진입”, 다른 하나는 “심층 구조 진입”처럼 역할을 더 명확하게 나누는 편이 좋습니다. |
| 96 | 96 | ||
| 97 | ### front matter와 본문의 동기화 | 97 | ### front matter와 본문의 동기화 |
| 98 | `related_docs`는 잘 연결되어 있으나, 본문의 “관련 문서” 섹션이 있는 문서와 없는 문서의 편차가 있습니다. | 98 | `related_docs`는 잘 연결되어 있으나, 본문의 “관련 문서” 섹션이 있는 문서와 없는 문서의 편차가 있습니다. |
| 99 | 다음 정리 단계에서는 모든 문서에 공통 형식으로 아래 섹션을 넣는 것이 좋습니다. | 99 | 다음 정리 단계에서는 모든 문서에 공통 형식으로 아래 섹션을 넣는 것이 좋습니다. |
| 100 | 100 | ||
| 101 | - 관련 문서 | 101 | - 관련 문서 |
| 102 | - 먼저 읽을 문서 | 102 | - 먼저 읽을 문서 |
| 103 | - 이어서 읽을 문서 | 103 | - 이어서 읽을 문서 |
| 104 | - 관련 코어 문서 | 104 | - 관련 코어 문서 |
| 105 | - 관련 플러그인 문서 | 105 | - 관련 플러그인 문서 |
| 106 | 106 | ||
| 107 | ### 내부 링크 표준화 | 107 | ### 내부 링크 표준화 |
| 108 | 앞으로는 다른 문서를 언급할 때 아래 형식 중 하나로 통일하는 것이 좋습니다. | 108 | 앞으로는 다른 문서를 언급할 때 아래 형식 중 하나로 통일하는 것이 좋습니다. |
| 109 | 109 | ||
| 110 | - 일반 링크: 문서 제목 + 실제 파일명 링크 형식 | 110 | - 일반 링크: 문서 제목 + 실제 파일명 링크 형식 |
| 111 | - 파일명 링크: ``파일명.md`` 또는 실제 파일 링크 형식 | 111 | - 파일명 링크: ``파일명.md`` 또는 실제 파일 링크 형식 |
| 112 | 112 | ||
| 113 | 이 원칙을 지키면 검색 허브와 별개로 폴더 브라우징만 하더라도 문서 간 이동이 훨씬 쉬워집니다. | 113 | 이 원칙을 지키면 검색 허브와 별개로 폴더 브라우징만 하더라도 문서 간 이동이 훨씬 쉬워집니다. |
| 114 | 114 | ||
| 115 | ## 권장 후속 작업 | 115 | ## 권장 후속 작업 |
| 116 | 116 | ||
| 117 | - `related_docs`를 이용해 자동 “관련 문서” 블록을 렌더링하는 허브 기능 추가 | 117 | - `related_docs`를 이용해 자동 “관련 문서” 블록을 렌더링하는 허브 기능 추가 |
| 118 | - 08/09 개발자 진입 문서의 역할 분리 | 118 | - 08/09 개발자 진입 문서의 역할 분리 |
| 119 | - 모든 문서 하단에 표준 내부 링크 블록 삽입 | 119 | - 모든 문서 하단에 표준 내부 링크 블록 삽입 |
| 120 | - 플러그인 문서 ↔ 코어 문서 사이의 상호 링크 확대 | 120 | - 플러그인 문서 ↔ 코어 문서 사이의 상호 링크 확대 |
| 121 | - 디렉터리 문서 ↔ 파일 문서 사이의 탐색 링크 강화 | 121 | - 디렉터리 문서 ↔ 파일 문서 사이의 탐색 링크 강화 |
| 122 | 122 | ||
| 123 | ## 참고 | 123 | ## 참고 |
| 124 | 124 | ||
| 125 | - [거시적 안내서](00-overview-macro-guide.md) | 125 | - [거시적 안내서](00-overview-macro-guide.md) |
| 126 | - [외부 자료 참고 인용 정리](73-external-reference-index.md) | 126 | - [외부 자료 참고 인용 정리](73-external-reference-index.md) |
| 127 | - [문서 감사 및 보완 보고서](99-audit-and-remediation-report.md) | 127 | - [문서 감사 및 보완 보고서](99-audit-and-remediation-report.md) |
| 128 | 128 | ||
| 129 | 이 보고서는 현재 문서 세트를 기준으로 작성되었으며, 이후 파일명 변경이나 문서 추가가 발생하면 다시 점검해야 합니다. | 129 | 이 보고서는 현재 문서 세트를 기준으로 작성되었으며, 이후 파일명 변경이나 문서 추가가 발생하면 다시 점검해야 합니다. |
| 130 | 130 | ||