菜单
세련된 README 파일, 변경 이력(changelog), 기여 가이드(contribution guide) 및 기술 문서를 작성하기 위한 전문가 수준의 Markdown 문서화 SKILL입니다. 사용 사례: (1) 배지와 섹션을 포함한 README 생성, (2) git 히스토리를 이용한 자동 변경 이력 생성, (3) 목차(table of contents) 생성, (4) 기여 가이드라인 작성, (5) 기술 문서 포맷팅, (6) 구문 강조(syntax highlighting)를 포함한 코드 문서화
用 Codex 或 Claude 帮你安装 复制这段 Prompt，粘贴到 Codex、Claude 或其他助手里，让它检查 Skill 页面并帮你完成安装。
基于 SOC 职业分类
OpenAPI/Swagger 사양, 인증 패턴, 버전 관리 전략 및 모범 사례를 사용하여 RESTful 및 GraphQL API를 설계하고 문서화합니다. 사용 사례: (1) API 사양 생성, (2) REST 엔드포인트 설계, (3) GraphQL 스키마 설계, (4) API 인증 및 권한 부여, (5) API 버전 관리 전략, (6) 문서 생성
코드나 구현 계획을 작성하기 전, 무언가를 생성하거나 개발할 때 사용합니다. 협력적인 질문, 대안 탐색 및 점진적 검증을 통해 거친 아이디어를 구체화된 설계로 발전시킵니다. 명확한 'Mechanical' 프로세스 중에는 사용하지 마십시오.
.NET 코드에서 정적 분석(Static analysis), 보안 스캔(Security scan) 및 종속성 체크(Dependency check)를 수행합니다. 코드 품질, 보안 감사 또는 취약점 탐지가 포함된 작업에서 사용합니다.
dotnet format, prettier 및 기타 포맷팅 도구를 사용하여 코드를 정리합니다. 코드 스타일 수정, 포맷 일관성 유지 또는 커밋 전 코드 준비가 필요한 작업에서 사용합니다.
보안 스캔, 품질 지표 및 모범 사례 분석을 포함한 자동화된 코드 리뷰입니다. 다음을 위한 코드 리뷰 시 사용합니다: (1) 보안 취약점 및 일반적인 공격 벡터, (2) 코드 품질 이슈 및 유지보수 문제, (3) 성능 병목 현상 및 최적화 기회, (4) 모범 사례 및 디자인 패턴, (5) 테스트 커버리지 및 테스트 전략, (6) 문서 품질 및 완전성
.NET/C#의 코딩 규약, 명명 규칙, 레이아웃, C# 12/13/14의 최신 기능 활용 가이드라인을 정의합니다. C#/.NET 코드 작성 시, 클래스·메서드 명명 시, 코드 포맷팅 시, 또는 사용자가 코딩 규약, 명명 규칙, C# 모범 사례, Primary Constructors, Collection Expressions, field 키워드에 대해 언급했을 때 사용합니다.
| name | markdown-pro |
| description | 세련된 README 파일, 변경 이력(changelog), 기여 가이드(contribution guide) 및 기술 문서를 작성하기 위한 전문가 수준의 Markdown 문서화 SKILL입니다. 사용 사례: (1) 배지와 섹션을 포함한 README 생성, (2) git 히스토리를 이용한 자동 변경 이력 생성, (3) 목차(table of contents) 생성, (4) 기여 가이드라인 작성, (5) 기술 문서 포맷팅, (6) 구문 강조(syntax highlighting)를 포함한 코드 문서화 |
이 SKILL은 전문적이고 잘 구조화된 Markdown 문서를 작성하기 위한 포괄적인 가이드를 제공합니다. 최신 포맷팅, 배지 및 모범 사례를 적용한 README 파일, 변경 이력, 기여 가이드 및 기술 문서를 다룹니다.
1. 배지를 포함한 헤더
# 프로젝트 이름
[](LICENSE)
[](releases)
[](builds)
프로젝트가 무엇인지 설명하는 짧은 한 줄 설명.
2. 목차 (Table of Contents) (내용이 긴 README의 경우)
## 목차
- [주요 특징](#features)
- [설치 방법](#installation)
- [사용법](#usage)
- [API 참조](#api-reference)
- [기여하기](#contributing)
- [라이선스](#license)
3. 주요 특징 섹션 (Features)
## 주요 특징
- **특징 1**: 장점과 함께 명확한 설명 제공
- **특징 2**: 어떤 문제를 해결하는지 기술
- **특징 3**: 독특한 강점 강조
- 크로스 플랫폼 지원 (Windows, macOS, Linux)
- 포괄적인 테스트 커버리지 (>90%)
4. 설치 방법 (Installation)
## 설치 방법
### 사전 요구 사항
- Python 3.8 이상
- pip 패키지 매니저
### 빠른 시작
```bash
pip install package-name
git clone https://github.com/username/repo.git
cd repo
pip install -e .
**5. 사용 예시 (Usage)**
```markdown
## 사용법
### 기본 예시
```python
from package import Module
# 초기화
client = Module(api_key="your-key")
# 작업 수행
result = client.process(data)
print(result)
더 자세한 사용 사례는 examples/ 디렉토리를 참조하세요.
**6. API 문서화 (API Reference)**
```markdown
## API 참조
### `Module.process(data, options=None)`
선택적 설정을 사용하여 입력 데이터를 처리합니다.
**매개변수:**
- `data` (str|dict): 처리할 입력 데이터
- `options` (dict, 선택 사항): 설정 옵션
- `verbose` (bool): 상세 출력 활성화 (기본값: False)
- `format` (str): 출력 형식 - 'json', 'yaml', 'xml' (기본값: 'json')
**반환값:**
- `dict`: 메타데이터가 포함된 처리 결과
**예외:**
- `ValueError`: 데이터가 유효하지 않은 경우
- `APIError`: API 요청이 실패한 경우
**예시:**
```python
result = client.process(
data={"key": "value"},
options={"verbose": True, "format": "json"}
)
**7. 기여하기 섹션 (Contributing)**
```markdown
## 기여하기
프로젝트 기여를 환영합니다! 가이드라인은 [CONTRIBUTING.md](CONTRIBUTING.md)를 참조하세요.
### 빠른 기여 가이드
1. 저장소 포크 (Fork)
2. 피처 브랜치 생성 (`git checkout -b feature/amazing-feature`)
3. 변경 사항 커밋 (`git commit -m 'Add amazing feature'`)
4. 브랜치 푸시 (`git push origin feature/amazing-feature`)
5. 풀 리퀘스트 (Pull Request) 오픈
8. 라이선스 및 크레딧
## 라이선스
이 프로젝트는 MIT 라이선스를 따릅니다. 자세한 내용은 [LICENSE](LICENSE) 파일을 참조하세요.
## 감사의 글
- 특징 X를 구현해준 [기여자 이름]님께 감사드립니다.
- [Project Name](link)에서 영감을 얻었습니다.
- [Technology Stack]으로 구축되었습니다.
# 변경 이력
이 프로젝트의 모든 주목할 만한 변경 사항은 이 파일에 기록됩니다.
형식은 [Keep a Changelog](https://keepachangelog.com/en/1.0.0/)를 따르며,
이 프로젝트는 [시맨틱 버저닝(Semantic Versioning)](https://semver.org/spec/v2.0.0.html)을 준수합니다.
## [Unreleased]
### Added
- 새로운 기능 설명
### Changed
- 기존 기능 수정 사항
### Deprecated
- 향후 삭제될 예정인 기능
### Removed
- 삭제된 기능
### Fixed
- 버그 수정
### Security
- 보안 개선 사항
## [1.2.0] - 2025-01-15
### Added
- 사용자 인증 시스템 (#123)
- CSV 내보내기 기능 (#145)
- 다크 모드 지원 (#156)
### Changed
- 응답성 개선을 위한 UI 컴포넌트 업데이트 (#134)
- 에러 메시지 개선 (#142)
### Fixed
- 백그라운드 프로세서의 메모리 누수 수정 (#139)
- 로그인 타임아웃 이슈 해결 (#148)
## [1.1.0] - 2024-12-01
### Added
- 핵심 기능을 포함한 초기 릴리스
```python
def hello_world():
"""헬로 월드 메시지 출력."""
print("Hello, World!")
function helloWorld() {
console.log("Hello, World!");
}
# 종속성 설치
npm install
# 테스트 실행
npm test
### 표 (Tables)
```markdown
| 기능 | 설명 | 상태 |
|---------|-------------|--------|
| 인증 | 사용자 인증 시스템 | ✅ 완료 |
| API | RESTful API 엔드포인트 | ✅ 완료 |
| 문서 | 문서화 작업 | 🚧 진행 중 |
| 테스트 | 유닛 및 통합 테스트 | ❌ 계획됨 |
<details>
<summary>클릭하여 고급 설정 확인</summary>
## 고급 옵션
고급 설정을 구성합니다:
```yaml
advanced:
cache_size: 1000
timeout: 30
retry_attempts: 3
> **참고**: 이 기능은 Python 3.8 이상이 필요합니다.
> **주의**: 이 작업은 되돌릴 수 없습니다!
> **중요**: 업그레이드 전에는 항상 데이터를 백업하세요.
<!-- 외부 링크 -->
[문서 보기](https://docs.example.com)
<!-- 내부 링크 -->
[설치 방법](#installation) 섹션을 참조하세요.
<!-- 참조 스타일 링크 -->
[프로젝트 홈페이지][homepage]와 [문서][docs]를 확인하세요.
[homepage]: https://example.com
[docs]: https://docs.example.com
<!-- 표준 이미지 -->
<!-- 대체 텍스트와 타이틀이 포함된 이미지 -->
<!-- 링크가 포함된 이미지 -->
[](https://youtube.com/watch?v=example)
<!-- License -->
<!-- Version -->
<!-- Build Status -->
<!-- Coverage -->
<!-- Language -->
<!-- Platform -->
헤더로부터 목차를 자동으로 생성하려면 헬퍼 스크립트를 사용하세요:
python scripts/markdown_helper.py toc README.md
git 히스토리에서 변경 이력 항목을 자동으로 생성합니다:
python scripts/markdown_helper.py changelog --since v1.0.0 --output CHANGELOG.md
문서 내 깨진 링크가 있는지 확인합니다:
python scripts/markdown_helper.py validate docs/
권장하는 모든 섹션이 포함된 운영 수준의 README 템플릿은 examples/README_template.md를 참조하세요.
Keep a Changelog 형식을 따르는 올바른 포맷의 변경 이력 템플릿은 examples/CHANGELOG_template.md를 참조하세요.
행동 강령(Code of conduct), 개발 환경 설정, PR 프로세스를 포함한 기여 가이드라인 템플릿은 examples/CONTRIBUTING.md를 참조하세요.
# H1 - 프로젝트 제목 (문서당 하나만 사용)
## H2 - 주요 섹션
### H3 - 하위 섹션
#### H4 - 부가적인 포인트
##### H5 - 드물게 사용되는 깊은 중첩
<!-- 순서 없는 목록 -->
- 항목 1
- 항목 2
- 중첩 항목
- 또 다른 중첩 항목
<!-- 순서 있는 목록 -->
1. 첫 번째 단계
2. 두 번째 단계
3. 세 번째 단계
<!-- 작업 목록 -->
- [x] 완료된 작업
- [ ] 진행 예정 작업
- [ ] 또 다른 대기 작업
*기울임* 또는 _기울임_
**굵게** 또는 __굵게__
***굵은 기울임*** 또는 ___굵은 기울임___
~~취소선~~
`인라인 코드`
전문적인 Markdown 문서화는 프로젝트의 접근성을 높이고, 기여자를 유도하며, 사용자에게 명확한 가이드를 제공합니다. examples/의 템플릿을 시작점으로 삼고, scripts/의 헬퍼 스크립트로 커스터마이징하며, 세련되고 유지보수가 용이한 문서를 위해 이 모범 사례들을 따르세요.