使用一个脚本创建演示项目模板

当您站在舞台上或在在线会议中进行现场演示时，让您的项目呈现完美状态似乎很容易。但是，为了创建可工作、易于使用且可重复的演示项目，幕后需要进行大量工作。

当您进行演示时，项目中的技术必须支持您关于项目的更宏大的故事，而不能失败。我和我的 JBoss 技术布道师同事经常需要设置不同的技术，因此我们有必要调整某种通用框架或模板来放置这些演示项目。

实现此目标以三个原则为指导

• KISS（保持简单，傻瓜化）
• 一致性
• 可重复性

这些原则源于我们旨在支持任何想要探索和开始使用 JBoss 技术的人。请注意，虽然这些原则的顺序在重要性方面具有一定的意义，但它们都必须相互平衡。

如果必须更侧重于其中一个原则，那么在使用技术时，就是 KISS 原则。因此，您会发现，在决定如何解决演示项目模板中的任何问题时，几乎都严格遵循此原则。

简单

演示需要简单的设置，几乎不需要任何努力即可启动它们，或者更现实地说，只需尽可能少的努力。

每个项目仅需三个步骤即可启动

1. 下载并解压项目。
2. 将产品添加到项目的 installs 目录。
3. 运行 init.sh（对于 Unix）或 init.bat（对于 Windows）来安装项目。

就是这样；只需观看安装的输出，然后根据您的需要继续进行项目。

此设置还依赖于 Unix 和 Windows 系统物理上可能的最少或最基本的依赖项集——Java 和 Maven，仅此而已。

演示的全部意义在于了解您面前的项目的作用，因此它必须清晰，并提供探索项目如何设置、配置和运行的可能性。根据多年来用户的反馈，完全自动化是不可取的，因为它会将项目从用户的学习领域中移除。

在通过自动配置和设置安装项目时，提供了一种平衡，但仍然有一些步骤允许您暂停、思考和探索已完成的工作。

一致性

人们能够在我们的各种技术和产品之间跳转的唯一方法是在我们的演示项目中保持某种一致性。客户、合作伙伴或感兴趣的各方需要能够识别简单明了的项目设置形式。

这通过简单明了的项目模板结构完成

• docs/ 包含项目文档和屏幕截图。
• installs/ 是您放置所需产品的地方。
• projects/ 包含服务、客户端或其他基于项目的代码的源代码。
• support/ 包含所有其他配置、设置或其他必要的文件和实用程序。
• init.{sh|bat} 存储设置项目所需的安装脚本。

就是这样；每次看起来都会是这样。

可重复性

没有什么比花费大量时间提供演示项目却只能运行一次更糟糕的了。通常，某些因素会加速项目的完成，以至于您几乎没有机会对其进行某种程度的整理。

我们的模板允许您在开发演示项目的同时保持其可重复性。请注意，整个设置都在名为 target 的新目录中完成，您可以在其中丢弃所有内容，然后再次设置项目（使用初始 init 脚本）。

这是一条黄金法则：每个演示项目都应在几分钟内（如果不是更短的时间）可重复。

通用演示模板项目

您想创建自己出色的演示，以说服您的朋友、团队和老板，您的项目正是他们所需要的吗？此模板将提供工具来设置简单、一致且易于重复的演示项目。

开始使用此模板

1. 下载并解压它.

运行 init.sh 来填充项目，并查看生成的 README 文件，了解如何使用它

$ ./init.sh PROJECTNAME

已发布版本

• v2.0—更新为通用模板项目创建
• v1.0—添加图像和最终修饰

本文改编自 Eric D. Schabell 的博客上的“如何创建简单、一致、可重复的演示项目”，并已获得许可重复使用。