mcpField
D
documentation-patterns

documentation-patterns

github.com/thalysjuvenalDevelopment19351 installsUpdated 7w ago
Repository

About documentation-patterns

documentation-patterns is a skill for generating Protheus-standard technical documentation from ADVPL/TLPP source code. It provides templates for function headers, full routine specifications, and REST endpoint documents, using code and available git history as input.

Key features

  1. 01Function and method header templates
  2. 02Full routine specification template
  3. 03REST endpoint documentation template
  4. 04Extraction of code details and dependencies
  5. 05Use of available git history

Use cases

  1. 01Add a Protheus.doc header to code
  2. 02Document a routine's behavior and dependencies
  3. 03Create REST endpoint documentation

Install

Copy the command and run it in a terminal.

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

After installing, type/documentation-patternsin Claude Code to confirm it loaded.

Bundled filesreference.md

Details

From the project README

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

Comments

Markdown supported