skillZs
★ LIVE SKILL TAGS ★
>>> LIVE SKILLS INDEX <<<
* OPEN SOURCE *
NO LOGIN, NO TRACKING
※ REAL INSTALL DATA ※
← back to all skills
thalysjuvenal/advpl-specialist53 installs

documentation-patterns

Use when the user wants to generate technical documentation for ADVPL/TLPP code on TOTVS Protheus -- Protheus.doc header blocks (@type, @param, @return, @author, @since, @history), complete routine documentation (tables read/written, MV_* parameters, entry points, execution flow, dependencies), or REST API endpoint documentation (path/query parameters, request/response JSON, status codes). Also triggers on Portuguese phrasing like "documentar rotina", "gerar cabecalho Protheus.doc", "documentar endpoint", "documentar API REST", or requests to add documentation to legacy/undocumented code.

How do I install this agent skill?

npx skills add https://github.com/thalysjuvenal/advpl-specialist --skill documentation-patterns
view source ↗

Is this agent skill safe to install?

  • Gen Agent Trust Hubpass

    The skill is designed to generate technical documentation for ADVPL/TLPP code by analyzing source files and git history. While safe for its intended purpose, it processes untrusted source code provided by users, which creates a potential surface for indirect prompt injection attacks where malicious code could influence the agent's behavior.

  • Socketpass

    No alerts

  • Snykpass

    Risk: LOW · No issues

What does this agent skill do?

ADVPL/TLPP Documentation Patterns

This skill provides templates and a generation process for turning ADVPL/TLPP source code into Protheus-standard technical documentation. It covers three output types: a header Protheus.doc comment block for a single function/method, a full markdown routine specification (objective, module, tables read/written, MV_* parameters, entry points, execution flow, dependencies, change history), and an api REST endpoint document (authentication, path/query parameters, request body, response schemas).

Activate this skill when the user asks to generate or add documentation for existing code -- headers, full routine specs, or API docs -- following TOTVS conventions. The process reads the target file, extracts functions/parameters/tables/MV_* usage/entry points/dependencies from the code itself, cross-checks git history for author and change log when available, then fills the appropriate template.

It does not cover explaining code in plain conversational language for an audience (see code-explanation), looking up native function signatures to fill in documentation accurately (see protheus-reference), or documenting the semantics of embedded SQL macros used inside a routine (see embedded-sql).

Reference fileRead when
reference.mdAlways -- the three documentation type templates (header/full/api) and the generation process

Add the canonical catalog link to the repository README so users can inspect current installs and available audits. The publishing guide covers the complete discovery path.

<a href="https://skillzs.dev/skills/thalysjuvenal/advpl-specialist/documentation-patterns">View documentation-patterns on skillZs</a>