README constructor
프로젝트와 독자에 맞는 README를 만듭니다. 사용자를 설계자로 대우합니다. Preset은 제안이며, 구조, 콘텐츠, 시각 자료는 독립적으로 선택할 수 있습니다. 프로젝트 증거와 사용자의 기존 결정을 활용하세요. 기능, 명령어, 결과, 이미지, 주장을 절대 지어내지 마십시오.
발견 및 제안
레시피를 제안하기 전에 관련 저장소, 기존 문서, 생성된 문서의 소스, 에셋을 검사합니다. README의 목적, 대상 독자, 제목, 톤, 렌더링 대상을 식별하여 설계에 영향을 미칠 때 고려합니다. 요청된 출력 경로나 채팅 전용 초안을 존중합니다. 출력이 생성되는 문서 소스를 편집합니다. 유용한 사실과 기존 에셋, 특히 기존 README의 경우 보존합니다.
아래 메뉴를 선택적으로 사용하세요. 이 패턴은 사용자가 적응할 수 있는 선택지를 제공합니다. 연결된 예제는 Awesome README index에서 선택한 대표적인 하위 집합이며, 짧은 원본 노트로 요약되어 있습니다. 이 스킬을 사용하는 데 네트워크 접속은 필요하지 않습니다.
- 구조 메뉴를 사용하여 정렬된 시작점과 섹션 선택지를 제안합니다.
- 섹션 콘텐츠 메뉴를 사용하여 각 선택된 섹션의 형식, 깊이, 증거를 선택합니다.
- 시각 자료 메뉴를 사용하여 개별 시각 자료, 배치, 사용 가능하거나 제안된 에셋을 선택합니다.
새 README 또는 대규모 재설계의 경우, 제안된 제목 순서, 각 섹션의 콘텐츠 선택, 개별적으로 배치된 시각 자료를 보여주는 하나의 맞춤형 편집 가능한 레시피를 제시합니다. 여전히 중요한 경우에만 간결한 컨텍스트 선택지를 포함합니다. 간결한 메뉴에서는 안정적인 ID를 사용하여 사용자가 섹션을 추가, 제거, 이름 변경, 재정렬하고, 콘텐츠를 독립적으로 선택하고, 개별 시각 자료를 선택할 수 있도록 합니다. 해당되는 경우 none, keep, skip, recommend, 자유 형식 선택지를 제공합니다. recommend가 선택을 위임한다고 설명합니다. 사용자가 preset과 독립적으로 콘텐츠와 시각 자료를 결정하도록 합니다.
사용자가 이미 제공한 선택지를 소비하고 레시피를 수정할 때 유지합니다. 재설계에서 keep이 기존 항목을 선택하는 경우 해당 항목을 보존하고 적용합니다. 해결되지 않은 설계 선택지만 묻고, 이를 관리 가능한 메시지로 그룹화합니다. 새 README 또는 대폭 재설계된 README를 초안 작성하기 전에 해당 선택지를 기다립니다. 단, 사용자가 결정을 위임한 경우는 예외입니다. 사용자가 충분한 지시를 내리거나 결정을 요청한 경우 적절한 기본값으로 진행합니다. 선택지가 해결되면 추가 승인 없이 요청된 결과물을 만듭니다. 좁은 범위의 편집의 경우, 새로운 생성 세션 없이 사용자의 요청을 직접 수행합니다.
이 간결한 교환을 프로젝트에 맞게 조정하세요.
제안된 순서는
S1 개요 → S2 빠른 시작 → S3 아키텍처입니다. 콘텐츠 선택지는S1 문제 + 범위,S2 최소 명령어,S3 일반 텍스트 구성 요소 맵입니다. 시각 자료 선택지는V1 S1 다음 스크린샷 (제안, 사용 가능한 항목 없음),V2 S3 다음 아키텍처 다이어그램 (제안)입니다. 섹션과 순서를 선택하고, 섹션의 콘텐츠를 변경하며, 시각 자료를 개별적으로 선택하세요.keep은 특정 제안 값을 수락하고,none은 섹션 또는 시각 자료를 제거하고,skip은 선택적 선택지를 생략하고,recommend는 선택을 위임합니다. 사용자 정의 텍스트는 환영합니다.사용자가
순서 S1, S3, S2 / S2 안내 / V1 none / V2 keep / 나머지 keep을 선택합니다.
결과 레시피는 S1과 S3의 콘텐츠를 유지하고, S2에 안내된 빠른 시작을 사용하며, V1을 생략하고, V2를 S3 뒤에 배치합니다. 수락된 선택지를 다시 열지 않고 남아 있는 중대한 불확실성을 해결합니다. 제안된 에셋과 기존 에셋을 구분합니다. 제안된 에셋은 사용자가 요청한 범위와 사용 가능한 도구 내에서만 만들거나 획득하고, 그렇지 않으면 생략하고 그 이유를 설명합니다.
생성 및 확인
선택된 레시피에 따라 섹션을 작성하고 프로젝트의 구체적인 내용을 지원합니다. 실용적인 경우 명령어를 안전하게 확인합니다. 확인되지 않은 명령어나 누락된 정보에 레이블을 지정하고, 단지 문서를 테스트하기 위해 파괴적이거나 부작용이 있는 명령어를 실행하지 않습니다. 제목 순서, 링크, 앵커, 선택된 플랫폼에 대한 마크다운 렌더링, 코드 펜스 및 언어 태그, 상대 자산 경로를 확인합니다. 의미 있는 이미지에 정보성 대체 텍스트를 제공하고, 시각 자료가 사용될 때 밝은 테마와 어두운 테마 모두에서 가독성을 확인합니다. 요청된 범위를 벗어난 기존 콘텐츠를 보존합니다. 결과와 함께 중대한 격차 및 확인 제한 사항을 보고합니다.