xxx 시스템 / 모듈
주의:
이 템플릿은 README. 를 쓰는 데 권장되는지도를 제공합니다.
모든 italics는 작성 가이드입니다. 공식 문서에서 삭제 된 것을 확인하십시오.
** 【일반 쓰기 요구 사항】 **
** 1. 쓰기 내용 확인: ** SYSTEM/module는 (무엇), 무엇을 할 수 있는지 (왜), 그것을 개발하는 방법 (방법).
** 2. 사용자의 관점을 채택: ** 개발자의 관점의 현재 내용, 그들이 돌보는 것에 초점을 맞추고 use.
** 3. 가동 가능: ** 템플릿은 참고 전용입니다. 실제 상황에 따라 유연성을 조정합니다.
제품정보
【문의】필수
Content 소개: TuyaOpen 아키텍처 전체 시스템 / 모듈의 역할, 기능 구현, 사용 시나리오 및 지원 장치.
주:
| 제품 정보 | 관련 상품 |
|---|---|
| 1 | ** 언어 요구 사항** |
| 1.1 | Writing style: Formal 언어, 콜렉티브 표현을 피. |
| 1.2 | 규정 준수 요구 사항 : 제 3 자 지적 재산과 같은 법적 및 준수 위험이있는 단어를 사용하지 마십시오. 특정 개념. |
| 1.3 | 일관된 용어 : 용어 라이브러리와 일관성을 보장하고 텍스트의 첫 번째 외관에 대한 전체 형태를 제공합니다. |
| 2 | ** 형식 요구 사항 ** |
| 2.1 | 부정 행위, 기간에 종료 문장. |
| 2.2 | 총알점 또는 분류된 리스트에서 현재 콘텐츠가 가능합니다. |
| 2.3 | 내용의 보조 설명에 대해서는 "Note/Attention/Warning"와 같은 스타일을 사용합니다. |
| 3 | ** 옵션 ** |
| 3.1 | 테이블은 헤더가 있어야하며 빈 셀은 "Not Applied/None"으로 채워야합니다. |
| 4 | ** 스크린 샷 ** |
| 4.1 | 도표는 통용되고 원본과 함께 사용되어야 합니다. |
| 4.2 | 그것은 use.png 체재 추천됩니다. |
| 4.3 | 중국어 사용 - 언어 수치 및 영어 - 언어 수치. |
건축 Diagram
【예약】옵션
| 제품 정보 | 관련 상품 |
|---|---|
| 1 | 시스템 / 모듈 아키텍처를 설명하고 주요 구성 요소의 필요한 설명을 제공합니다. |
| 2 | 이 모듈은 하위 시스템의 일부인 경우 하위 시스템 이해를 나타냅니다. 관련 개념은 필수이며 참조를 제공합니다. |
비밀번호
【예약】필수. Clarify 이 프로젝트의 코드 디렉토리 구조와 각 디렉토리의 기능 설명.
├── include # Framework code
│ ├── tkl_mutex.h # Header file directory
│ ├── tkl_adc.h
├── src
│ ├── tkl_mutex.c
│ ├── tkl_adc.c
├── tools
│ └── test-tools.py # Test Tool directory
사용 제한
【예약】옵션. 하위시스템을 실행하기 위한 필수 조건을 지정합니다.
| 제품 정보 | 관련 상품 |
|---|---|
| 1 | Clarify 기능 또는 운영 제한. |
| 2 | 작업에 영향을 미치는 제약 - Guided development. |
회사연혁
【예약】옵션
| 제품 정보 | 관련 상품 |
|---|---|
| 1 | 좋은 단계 쓰기 방법 |
| 1.1 | Step completeness: 작업의 성공적인 완료를 보장하기 위해 필요한 모든 단계를 제공합니다. |
| 1.2 | 작업 문장: "verb + noun" 구조를 사용합니다. |
| 1.3 | 명확한 목적 : 각 단계의 목적을 지정, 즉, 원하는 목표. |
| 1.4 | 단계 완료 후 성공 기준을 포함. |
| 2 | **Good Code Segments 작성 방법 ** |
| 2.1 | 코드를 수정하고 실행할 수 있습니다. |
| 2.2 | 중요한 단계에 대한 명확한 의견 추가. |
인터페이스 Description
【예약】옵션. 이 저장소에 API 인터페이스에 대한 링크를 제공합니다.
관련 저장소
【예약】옵션. 개발자가 더 학습할 수 있는 관련 저장소에 대한 링크 목록.