이번 문서 감사에서 가장 크게 드러난 문제는 외부 근거를 적을 때 사람이 읽기 어려운 내부 추적 표기가 남았다는 점과, 일부 가이드 문서가 너무 짧아 실무 활용도가 떨어졌다는 점이었습니다. 따라서 앞으로는 참고 자료를 반드시 실제 URL 중심으로 적고, 짧은 문서는 예시·운영 팁·테스트 포인트를 추가해 독립 문서로서 충분한 밀도를 갖추도록 하는 것이 좋습니다.
이번 문서 감사에서 가장 크게 드러난 문제는 외부 근거를 적을 때 사람이 읽기 어려운 내부 추적 표기가 남았다는 점과, 일부 가이드 문서가 너무 짧아 실무 활용도가 떨어졌다는 점이었습니다. 따라서 앞으로는 참고 자료를 반드시 실제 URL 중심으로 적고, 짧은 문서는 예시·운영 팁·테스트 포인트를 추가해 독립 문서로서 충분한 밀도를 갖추도록 하는 것이 좋습니다.
| 이전 | 새 버전 | ||
|---|---|---|---|
| 1 | --- | 1 | --- |
| 2 | title: 문서 작성 규칙 | 2 | title: 문서 작성 규칙 |
| 3 | document_id: 69-document-writing-rules | 3 | document_id: 69-document-writing-rules |
| 4 | slug: 69-document-writing-rules | 4 | slug: 69-document-writing-rules |
| 5 | target_editor_version: 9.0.0 | 5 | target_editor_version: 9.0.0 |
| 6 | document_type: documentation | 6 | document_type: documentation |
| 7 | doc_type: documentation | 7 | doc_type: documentation |
| 8 | target_readers: [초보자, 웹마스터, 개발자, AI agent] | 8 | target_readers: [초보자, 웹마스터, 개발자, AI agent] |
| 9 | importance: High | 9 | importance: High |
| 10 | dependency: Medium | 10 | dependency: Medium |
| 11 | core_type: Documentation | 11 | core_type: Documentation |
| 12 | stability: [Version-Bound] | 12 | stability: [Version-Bound] |
| 13 | stable_anchor: [] | 13 | stable_anchor: [] |
| 14 | version_bound: [] | 14 | version_bound: [] |
| 15 | related_docs: [] | 15 | related_docs: [] |
| 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: 29 | 22 | reading_order: 29 |
| 23 | summary: T2Editor 문서를 작성할 때 따라야 할 규칙과 형식을 정의 문서 | 23 | summary: T2Editor 문서를 작성할 때 따라야 할 규칙과 형식을 정의 문서 |
| 24 | description: T2Editor 문서를 작성할 때 따라야 할 규칙과 형식을 정의 | 24 | description: T2Editor 문서를 작성할 때 따라야 할 규칙과 형식을 정의 |
| 25 | tags: [documentation, rules] | 25 | tags: [documentation, rules] |
| 26 | version_tag: 9.0.0 | 26 | version_tag: 9.0.0 |
| 27 | maintenance_difficulty: Medium | 27 | maintenance_difficulty: Medium |
| 28 | test_requirement: Medium | 28 | test_requirement: Medium |
| 29 | ai_agent_risk: Medium | 29 | ai_agent_risk: Medium |
| 30 | source_basis: [현재 코드 분석 기반, 웹 참고 자료 기반] | 30 | source_basis: [현재 코드 분석 기반, 웹 참고 자료 기반] |
| 31 | beginner_section_included: true | 31 | beginner_section_included: true |
| 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 | - **메타 정보**: 각 문서의 상단에는 제목, 문서 ID, 슬러그, 설명, 태그, 문서 유형, 버전 태그 등을 포함해야 합니다. | 37 | - **메타 정보**: 각 문서의 상단에는 제목, 문서 ID, 슬러그, 설명, 태그, 문서 유형, 버전 태그 등을 포함해야 합니다. |
| 38 | - **독자 구분**: 초보자/웹마스터용 설명과 전문 개발자용 설명을 구분하여 작성합니다. | 38 | - **독자 구분**: 초보자/웹마스터용 설명과 전문 개발자용 설명을 구분하여 작성합니다. |
| 39 | - **참고 자료**: 웹에서 참고한 자료는 반드시 인용하고, 실제 확인한 링크만 나열합니다. | 39 | - **참고 자료**: 웹에서 참고한 자료는 반드시 인용하고, 실제 확인한 링크만 나열합니다. |
| 40 | - **길이 요구사항**: 플러그인과 코어 파일 문서는 최소 2,500자 이상 작성해야 합니다. | 40 | - **길이 요구사항**: 플러그인과 코어 파일 문서는 최소 2,500자 이상 작성해야 합니다. |
| 41 | 41 | ||
| 42 | ## 스타일 가이드 | 42 | ## 스타일 가이드 |
| 43 | 43 | ||
| 44 | - 자연스럽고 구체적인 문체를 사용하고, 번역투와 기계식 나열을 피합니다. | 44 | - 자연스럽고 구체적인 문체를 사용하고, 번역투와 기계식 나열을 피합니다. |
| 45 | - 리스트와 표를 적절히 활용하여 정보를 구조화합니다. | 45 | - 리스트와 표를 적절히 활용하여 정보를 구조화합니다. |
| 46 | - 중복되는 내용은 최소화하되, 독립적인 문서가 될 수 있도록 필요한 배경 설명을 포함합니다. | 46 | - 중복되는 내용은 최소화하되, 독립적인 문서가 될 수 있도록 필요한 배경 설명을 포함합니다. |
| 47 | 47 | ||
| 48 | ## 감사 결과에 따른 문서 품질 기준 보완 | 48 | ## 감사 결과에 따른 문서 품질 기준 보완 |
| 49 | 49 | ||
| 50 | 이번 문서 감사에서 가장 크게 드러난 문제는 외부 근거를 적을 때 사람이 읽기 어려운 내부 추적 표기가 남았다는 점과, 일부 가이드 문서가 너무 짧아 실무 활용도가 떨어졌다는 점이었습니다. 따라서 앞으로는 참고 자료를 반드시 실제 URL 중심으로 적고, 짧은 문서는 예시·운영 팁·테스트 포인트를 추가해 독립 문서로서 충분한 밀도를 갖추도록 하는 것이 좋습니다. | 50 | 이번 문서 감사에서 가장 크게 드러난 문제는 외부 근거를 적을 때 사람이 읽기 어려운 내부 추적 표기가 남았다는 점과, 일부 가이드 문서가 너무 짧아 실무 활용도가 떨어졌다는 점이었습니다. 따라서 앞으로는 참고 자료를 반드시 실제 URL 중심으로 적고, 짧은 문서는 예시·운영 팁·테스트 포인트를 추가해 독립 문서로서 충분한 밀도를 갖추도록 하는 것이 좋습니다. |
| 51 | 51 | ||
| 52 | ## 참고 자료 표기 원칙 | 52 | ## 참고 자료 표기 원칙 |
| 53 | 53 | ||
| 54 | - 내부 추적용 식별자는 최종 산출물에 남기지 않는다. | 54 | - 내부 추적용 식별자는 최종 산출물에 남기지 않는다. |
| 55 | - 실제로 확인한 URL만 남긴다. | 55 | - 실제로 확인한 URL만 남긴다. |
| 56 | - 공식 자료, 커뮤니티 자료, 비교 자료를 구분한다. | 56 | - 공식 자료, 커뮤니티 자료, 비교 자료를 구분한다. |
| 57 | - 문서 말미의 참고 자료만 보더라도 출처의 성격을 이해할 수 있게 적는다. | 57 | - 문서 말미의 참고 자료만 보더라도 출처의 성격을 이해할 수 있게 적는다. |
| 58 | 58 | ||