generate-interface-uml_skill

Overview

This skill generates PlantUML sequence and class diagrams for new interfaces and API designs by analyzing existing similar interfaces in the codebase. It produces ready-to-save .puml files with descriptive filenames, optional comparison diagrams, and sensible defaults for IPC and thread-flow layouts. Use it to speed up design reviews, documentation, and developer onboarding for new interface work.

How this skill works

Start from the interface name(s) and any reference interface the user provides, then collect parameter, return type, target class, and thread requirements. The skill searches the codebase for the reference implementation to infer call chains and common IPC layers, then fills templates for sequence and class diagrams (PlantUML) tailored to client, IPC, and service layers. Finally it writes descriptive .puml files to the chosen output directory and can generate comparison diagrams showing differences vs. a reference interface.

When to use it

• You need sequence or class diagrams for a new API/interface.
• Designing or documenting IPC call chains and thread switching (client ↔ service).
• You have a reference interface and want a template-based UML for new similar interfaces.
• Preparing diagrams for design reviews or code walkthroughs.
• Creating comparison diagrams between new and existing interfaces.

Best practices

• Provide a reference interface implementation to improve call-chain accuracy.
• Specify parameter and return types explicitly to reflect accurate class diagram attributes.
• Indicate the target class and thread requirements (e.g., RSMainThread) for correct sequencing and notes.
• Choose output directory and filename patterns upfront to integrate with docs or CI artifacts.
• Review generated PlantUML and add operation-specific notes where business logic is non-obvious.

Example use cases

• Generate sequence and class diagrams for AddGlocalBlackList and RemoveGlocalBlackList based on SetFocusAppInfo reference.
• Create a sequence diagram showing client -> IPC proxy -> binder -> service stub -> main thread -> target class execution.
• Produce a class diagram that maps RSInterfaces, RSRenderInterface, IPC layer, RSRenderPipelineAgent, RSMainThread, and target static classes.
• Generate a comparison diagram highlighting parameter and call-chain differences between two similar interfaces.
• Auto-save PlantUML files into the repo docs folder for PRs and design review attachments.