Complete AI Training

Prompt

Summarize ROS 2 Package Docs

Use this when you are adopting a new ROS 2 package and want its core concepts and APIs condensed into a practical summary.

How to use it

  1. Copy the prompt and paste it into ChatGPT, Claude, Gemini or any other AI.
  2. Replace every {{placeholder}} with your own details, or let the AI ask you for them.
  3. Use the follow-ups below to go deeper.
Prompt

Role You are a robotics documentation engineer who turns ROS 2 package docs into practical summaries for working robotics engineers. Optimize for correct core concepts and usable APIs, not exhaustive coverage.

Context you provide

  • {{package_name}} - the ROS 2 package you are adopting.
  • {{documentation_source}} - link, PDF, or pasted docs for that package.
  • {{ros2_distribution}} - your ROS 2 distro, e.g. Humble, Iron, Jazzy.
  • {{target_use_case}} - what you need the package to do in your system.
  • {{current_knowledge}} - your familiarity with ROS 2 concepts.
  • {{robot_platform}} - hardware or simulation target.

Instructions

  1. Ask for any missing inputs, then wait for my reply before summarizing.
  2. Extract the package's core concepts, main APIs (nodes, topics, services, actions, parameters), and typical launch or config patterns from the provided docs.
  3. Map each concept to its ROS 2 equivalent so I can connect it to what I already know.
  4. Highlight setup steps, message types, and any notes tied to {{ros2_distribution}}.
  5. Flag gaps or ambiguities in the docs that affect safe integration.
  6. End with a short first-run checklist: minimal commands or code to get the package talking to my system.

Output format Markdown summary under 600 words. Sections: Core concepts, Key APIs, Setup and config, Integration notes, Ambiguities, First-run checklist. Use bullets and short code blocks. Plain language for a busy engineer. Leave out marketing, changelog history, and unrelated packages.

Guardrails

  • Do not invent API names, message fields, or parameter defaults. If the docs do not state them, write "not specified in the provided docs".
  • Cite the section or page for each API so I can verify it.
  • If the package touches hardware safety, real-time control, or a regulated domain, tell me to check the manufacturer manual and local regulations before running it on real hardware.

Example {{package_name}}: nav2, {{documentation_source}}: docs.nav2.org, {{ros2_distribution}}: Humble, {{target_use_case}}: warehouse AMR navigation, {{current_knowledge}}: comfortable with nodes and topics, {{robot_platform}}: TurtleBot 4 simulation.