sap-object-documenter

Generate Markdown documentation for ABAP objects in a package.

156|39|Updated Mar 25, 2026
One-click install
npx skills add https://github.com/arc-mcp/arc-1 --skill sap-object-documenter
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: sap-object-documenter
Source: https://github.com/arc-mcp/arc-1/tree/main/skills/sap-object-documenter
Command: npx skills add https://github.com/arc-mcp/arc-1 --skill sap-object-documenter

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes scripts (resource) and references (resource) components.

What problem does it solve?

This Skill addresses the challenge of documenting multiple ABAP objects within a package, providing a summary of each object's purpose and dependencies.

Core Features & Use Cases

  • Documentation Generation: Automatically produce Markdown documentation for all custom ABAP objects in a package.
  • Style Classification: Classify objects by style (Classic, Modern, Mixed) to aid in code maintenance and onboarding.
  • Use Case: When tasked with documenting a package, generating onboarding materials, or preparing for knowledge transfer.

Quick Start

Run the sap-object-documenter skill on the package 'Z_SALES_EXTENSIONS' to document all objects within it.

Frequently Asked Questions about sap-object-documenter

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I generate markdown documentation for ABAP objects in a package?

Generating markdown documentation for ABAP objects requires automating package extraction to produce files detailing purpose, dependencies, and style classification. This provides comprehensive code summaries for onboarding and maintenance.

What does ABAP style classification mean for code maintenance?

ABAP style classification categorizes objects as Classic, Modern, or Mixed to aid code maintenance and onboarding. This highlights architectural patterns within a package, helping developers understand legacy dependencies and modernization scope quickly.

Do I need SAP API access to document custom ABAP objects?

Yes, SAP API access is required to document custom ABAP objects. The documentation process queries the API to extract object lists and metadata, while optional mcp-sap-docs integration can provide additional business context lookup.

Can I use a type prefix to filter which ABAP objects are documented?

Yes, you can use a type prefix to filter ABAP objects during documentation generation. The system supports package documentation, object lists, and type prefix inputs to scope the automated markdown output to specific object categories.