# ai-generated-tutorial **Repository Path**: hsoalgyer/ai-generated-tutorial ## Basic Information - **Project Name**: ai-generated-tutorial - **Description**: No description available - **Primary Language**: Unknown - **License**: Not specified - **Default Branch**: master - **Homepage**: None - **GVP Project**: No ## Statistics - **Stars**: 0 - **Forks**: 0 - **Created**: 2026-03-17 - **Last Updated**: 2026-04-15 ## Categories & Tags **Categories**: Uncategorized **Tags**: None ## README # 简介 ai生成的教程归档项目 ## 提示词 ### 生成一项编程技能教程的提示词 ```markdown 请生成一份关于【FreeRTOS】的详细教程。请严格按照以下要求组织内容,并以单个Markdown文档的形式输出。 ### 一、文件夹与文件结构 生成的教程分成若干文件夹,文件夹命名要有数字前缀,文件夹内的md文件也要有数字前缀,如果有示例代码则放在子文件夹内不要和文件夹内的md文档混在一起 ### 二、代码标注与注释 - 在每个代码块上方用一行文字注明文件路径,例如:`文件:src/main.c`。 - 代码块内部必须包含充分注释,解释关键逻辑、函数作用、参数含义等,注释风格应符合语言惯例。 ### 三、概念解释原则 - 每当引入一个新概念时,首先解释概念是什么、有何用途、适用场景。对于复杂概念,应提供具体例子。 - 如果该概念不是本教程重点,只需简要介绍;若后续有专门章节深入讲解,需注明(例如“详见第X章”)。 ### 四、内容重点 教程需突出以下要点(顺序可灵活调整): 1. **技能概述**:该技能是什么,为什么重要。 2. **重要概念**:核心术语和思想,配合例子解释。 3. **核心构成**:框架、组件或模块,以及它们如何协同工作。 4. **解决的问题**:该技能诞生的背景及典型应用问题。 5. **典型应用场景**:列举实际应用案例,说明为何选择该技能。 6. **常用技巧**:高效使用的方法、编程模式、最佳实践。 7. **成熟项目中的应用**:介绍一两个真实项目或示例,展示该技能如何落地。 8. **容易疏漏和踩坑的地方及处理方法**:列出常见错误、易忽视的细节,并说明如何避免或解决 此外,可酌情加入高级技巧、扩展知识等,但需确保重点内容完整清晰。 ### 五、图表辅助 - 在适当位置使用Mermaid语法绘制**状态图、序列图、流程图**等,以直观展示逻辑、状态转换或组件交互。例如: ```mermaid graph TD; A-->B; ``` ### 六、其他要求 - 教程应循序渐进,适合具备一定基础的开发者学习。 请根据以上要求生成教程内容。 ```