113-java-maven-documentation

Compare original and translation side by side

🇺🇸

Original

English

🇨🇳

Translation

Chinese

Create DEVELOPER.md for the Maven projects

为Maven项目创建DEVELOPER.md

Generate a

DEVELOPER.md

file that combines a fixed base template with dynamic sections derived from analysing the project

pom.xml

What is covered in this Skill?

Base template reproduction (verbatim)
Plugin goals reference: table of
```
./mvnw
```
goals per explicitly declared plugin, max 8 goals each
Maven Profiles table: profile ID, activation trigger, representative command, description
Submodules table (multi-module projects only)

生成一个

DEVELOPER.md

文件，结合固定的基础模板与通过分析项目

pom.xml

得到的动态部分。

本Skill涵盖哪些内容？

基础模板还原（完全照搬）
插件目标参考：每个显式声明的插件对应的
```
./mvnw
```
目标表格，每个插件最多8个目标
Maven Profiles表：Profile ID、激活触发条件、代表性命令、描述
子模块表（仅适用于多模块项目）

Constraints

约束条件

Before generating any content, read every pom.xml in the workspace. Only include plugins explicitly declared in the project POMs — never plugins inherited from parent POMs or the Maven super-POM unless redeclared.

MANDATORY: Read every
```
pom.xml
```
in the workspace (root and submodules) before generating any content
PLUGIN SCOPE: Only include plugins explicitly declared in
```
<build><plugins>
```
or
```
<build><pluginManagement><plugins>
```
— never plugins inherited from parent POMs or the Maven super-POM unless redeclared
SCOPE: Execute steps 1–5 in order. Omit Profiles section if no profiles; omit Submodules section if not multi-module
BEFORE APPLYING: Read the reference for the base template content, plugin catalog, and detailed constraints for each step

在生成任何内容之前，请读取工作区中的所有pom.xml文件。仅包含项目POM中显式声明的插件——除非重新声明，否则绝不包含从父POM或Maven超级POM继承的插件。

强制要求：在生成任何内容之前，读取工作区中的所有
```
pom.xml
```
文件（根目录和子模块）
插件范围：仅包含在
```
<build><plugins>
```
或
```
<build><pluginManagement><plugins>
```
中显式声明的插件——除非重新声明，否则绝不包含从父POM或Maven超级POM继承的插件
执行范围：按顺序执行步骤1–5。如果没有Profiles则省略Profiles部分；如果不是多模块项目则省略子模块部分
使用前须知：查阅基础模板内容、插件目录以及每个步骤的详细约束条件的参考文档

When to use this skill

何时使用本Skill

Create DEVELOPER.md
Generate DEVELOPER.md
Maven project documentation
Add Maven documentation
Plugin goals reference
Maven Profiles table
Submodules table

创建DEVELOPER.md
生成DEVELOPER.md
Maven项目文档
添加Maven相关文档
插件目标参考
Maven Profiles表
子模块表

Reference

参考资料

For detailed guidance, examples, and constraints, see references/113-java-maven-documentation.md.

如需详细指南、示例和约束条件，请参阅references/113-java-maven-documentation.md。