CtrlK
BlogDocsLog inGet started
Tessl Logo

113-java-maven-documentation

Use when you need to create a DEVELOPER.md file for a Maven project — combining a fixed base template with dynamic sections derived from the project pom.xml, including a Plugin Goals Reference, Maven Profiles table, and Submodules table for multi-module projects. This should trigger for requests such as Create DEVELOPER.md; Generate DEVELOPER.md; Maven project documentation; Add Maven documentation; Plugin goals reference. Part of cursor-rules-java project

80

Quality

75%

Does it follow best practices?

Impact

No eval scenarios have been run

SecuritybySnyk

Passed

No known issues

Optimize this skill with Tessl

npx tessl skill review --optimize ./skills/113-java-maven-documentation/SKILL.md
SKILL.md
Quality
Evals
Security

Create DEVELOPER.md for the Maven projects

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)

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

When to use this skill

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

Workflow

  1. Read all POM files in workspace

Read root and every submodule pom.xml before generating content.

  1. Read documentation reference assets

Read references/113-java-maven-documentation.md to use the base template and plugin catalog constraints exactly.

  1. Assemble DEVELOPER.md base and dynamic sections

Generate DEVELOPER.md with verbatim base template plus dynamic sections: plugin goals, profiles (if any), and submodules (if multi-module).

  1. Enforce plugin scope and section omission rules

Include only explicitly declared plugins and omit Profiles/Submodules sections when not applicable.

Reference

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

Repository
jabrena/cursor-rules-java
Last updated
Created

Is this your skill?

If you maintain this skill, you can claim it as your own. Once claimed, you can manage eval scenarios, bundle related skills, attach documentation or rules, and ensure cross-agent compatibility.