Skip to content

Commit

Permalink
refactor(docs): modify pattern document for learn
Browse files Browse the repository at this point in the history
- Modify the file `docs/patterns/document-for-learn.md` to improve the content and structure of the document pattern for learning.
- Update the usage scenario for document-guided learning, explaining how it promotes knowledge and skill acquisition through practical exercises and guidance from related documents.
- Include an example of using the Ionic framework for document-guided learning, with subtopics on getting started, developing, layout, and theming.
  • Loading branch information
phodal committed Feb 23, 2024
1 parent 1d9fab4 commit 3f10e61
Show file tree
Hide file tree
Showing 5 changed files with 50 additions and 27 deletions.
30 changes: 16 additions & 14 deletions docs/patterns/developer-portal.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,37 +6,39 @@ nav_order: 2
---

# 实践模式:开发者门户

{: .no_toc }

## 目录

{: .no_toc .text-delta }

1. TOC
{:toc}
{:toc}

---
**度量模型**

开发者门户(Devportal)是 API、SDK 或其他交互式数字工具与其各种利益相关者之间的接口。它常常可以用于扮演多种角色来实现组织的业务目标,如可以用于构建产品与社区之间的桥梁。


## 度量模型
1. **TTFHW(Time to First Hello World):** TTFHW
是开发者门户度量模型中的一个关键指标,它表示用户从开始使用API、SDK或数字工具到成功实现第一个 "Hello World"
或基本操作的所需时间。较短的 TTFHW 通常表示工具易用性较高,用户能够快速上手。

1. TTFHW

## 示例
**示例**

### PyTorch

显式化告诉用户合适的版本
PyTorch的开发者门户为用户提供了明确的版本信息,帮助用户选择合适的版本,如下图所示

![](https://pytorch.org/assets/images/amd_rocm_blog.png)
![PyTorch版本选择](https://pytorch.org/assets/images/amd_rocm_blog.png)

在这个示例中,PyTorch的开发者门户通过图形化界面向用户展示了不同版本的选择,从而简化了配置过程,降低了 TTFHW。

### Stripe

Stripe是一个在线支付解决方案的开发者门户,提供了详细的参考资料,包括 API
文档、示例代码和常见问题解答。这些资源帮助开发者更轻松地集成Stripe支付服务到他们的应用中,减少了开发过程中的困难和延迟。

### BackStage


参考资料:

《》
BackStage是Spotify开源的开发者门户工具,用于管理多个微服务的生命周期。它提供了统一的界面,使开发者能够轻松访问各种工具、服务和文档。通过
BackStage,开发者可以更高效地管理、发现和使用内部工具,促进了团队协作和项目开发的顺利进行。
21 changes: 10 additions & 11 deletions docs/patterns/document-for-learn.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,31 +6,30 @@ nav_order: 3
---

# 实践模式:文档引导学习
{: .no_toc }

使用场景:
{: .no_toc }

> 文档引导学习是一种学习方法,其核心思想是通过实际的操作和实践来促进知识和技能的习得,同时辅以相关文档进行引导和说明。
## 目录

{: .no_toc .text-delta }

1. TOC
{:toc}
{:toc}

---

## 示例

### Ionic
## 示例: Ionic

文档:[https://ionicframework.com/docs](https://ionicframework.com/docs)

- Getting Started
- Overview
- Environment Setup
- CLI installation
- Packages & CDN
- Next Steps. -> Angular, Rect, Vue
- Overview
- Environment Setup
- CLI installation
- Packages & CDN
- Next Steps. -> Angular, Rect, Vue
- Developing
- Layout
- Theming
Expand Down
11 changes: 9 additions & 2 deletions docs/patterns/interactive-script.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,12 +6,19 @@ nav_order: 12
---

# 实践模式:一键交互环境

{: .no_toc }

## 示例:Google Colab

> Google Colab 是一种基于云端的交互式平台,用于开发机器学习应用程序。它是由Google Research创建的一款免费的工具,可在浏览器中使用,用户可以利用它来编写和执行Python代码。
> Google Colab 是一种基于云端的交互式平台,用于开发机器学习应用程序。它是由Google
> Research创建的一款免费的工具,可在浏览器中使用,用户可以利用它来编写和执行Python代码。
Google Colab支持Python语言,并且预装了许多常见的机器学习框架,如TensorFlow、Keras和PyTorch等,可以轻松使用它们来构建、训练和测试深度学习模型。

Google Colab 还提供了GPU和TPU(Tensor Processing Unit)等硬件加速选项,用户可以充分利用它们来加快模型的训练和推理速度。此外,Google Colab还可以与Google Drive集成,让用户轻松地保存和分享Notebook。
Google Colab 还提供了GPU和TPU(Tensor Processing Unit)等硬件加速选项,用户可以充分利用它们来加快模型的训练和推理速度。此外,Google
Colab还可以与Google Drive集成,让用户轻松地保存和分享Notebook。

## Jupiter Notebook

> Jupiter Notebook 是一种基于Web的交互式计算环境,它支持多种编程语言,如Python、R、Julia等。用户可以在Notebook中编写和执行代码,同时还可以添加文本、图像、公式、图表等内容,以便于记录和分享计算过程。
3 changes: 3 additions & 0 deletions docs/patterns/issue-bot.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,9 @@ parent: 实践模式
nav_order: 7
---

> Issue 机器人是一种自动化工具,通常集成在软件开发和项目管理平台中,用于处理和跟踪项目中的问题报告(Issues)。这些问题报告可以包括软件缺陷、功能请求、任务、建议等。
## 示例:Intellij IDEA

Intellij 相关的 IDEA 会在异常时:

Expand Down
12 changes: 12 additions & 0 deletions docs/patterns/starter-generator.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,18 @@ parent: 实践模式
nav_order: 9
---

脚手架生成器(Scaffold
Generator)是一种工具或平台,用于快速生成项目或应用程序的基础结构和代码骨架。这些生成器旨在简化开发流程,提高开发效率,并确保项目的一致性和最佳实践。通过提供预定义的项目模板、配置和依赖项,脚手架生成器帮助开发人员避免从头开始创建项目的繁琐工作。

脚手架生成器的特点包括:

1. 模板引擎: 使用模板引擎来生成项目代码,使得可以根据用户的需求和配置动态生成各种文件和结构。
2. 配置选项: 提供用户友好的配置选项,让开发人员能够根据项目需求进行个性化设置,例如选择框架版本、添加特定功能模块等。
3. 依赖管理: 自动处理项目所需的依赖项和库,确保项目能够正常运行,并提供最新的稳定版本。
4. 多框架支持: 支持生成不同框架的项目结构,以满足不同技术栈和开发团队的需求。

## 示例

- Quarkus 框架:[https://code.quarkus.io/](https://code.quarkus.io/)
- Spring 框架:[https://start.spring.io/](https://start.spring.io/)

0 comments on commit 3f10e61

Please sign in to comment.