skills.rest
totvs
totvsOFFICIAL
Explore all skills by this author →
Website𝕏@TOTVSDevelopersGitHub

documentation-writer

Generate ProtheusDOC comment blocks for AdvPL and TLPP source code elements.

115|54|Updated May 25, 2026
Search Tags:#developer productivity#code documentation#advpl#tlpp#api comments#protheusdoc#tagged metadata
One-click install
npx skills add https://github.com/totvs/engpro-advpl-tlpp-skills --skill documentation-writer-totvs
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: documentation-writer
Source: https://github.com/totvs/engpro-advpl-tlpp-skills/tree/main/skills/advpl-tlpp/documentation-writer
Command: npx skills add https://github.com/totvs/engpro-advpl-tlpp-skills --skill documentation-writer-totvs

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

It helps you create consistent, standard-compliant ProtheusDOC comment blocks so your AdvPL/TLPP code can be documented and understood through generated documentation.

Core Features & Use Cases

  • ProtheusDOC Standard Output: Produces documentation blocks with the correct opening/closing markers, identifier rules, mandatory @type tag, and supported optional tags.
  • Element-Aware Documentation: Generates blocks for functions, classes, and methods using the proper identifier format (including ClassName::MethodName for methods).
  • Batch Documentation Guidance: Supports workflows like documenting new elements, fixing incomplete blocks, or preparing documentation for an entire .prw or .tlpp file.

Quick Start

Generate ProtheusDOC comment blocks for the functions, classes, and methods inside my AdvPL/TLPP source file using the official TOTVS tag and identifier format.

Frequently Asked Questions about documentation-writer

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

FAQPage Schema
How do I generate ProtheusDOC comment blocks for AdvPL source code?▼

You generate ProtheusDOC comment blocks for AdvPL by applying the official identifier format and mandatory @type tag to functions, classes, and methods, ensuring your source code documentation remains consistent and discoverable.

What is the correct ProtheusDOC format for TLPP class methods?▼

The correct ProtheusDOC format for TLPP class methods requires the ClassName::MethodName identifier structure, proper opening and closing markers, a mandatory @type tag, and appropriately typed @param and @return tags.

Can I fix incomplete API documentation blocks in an entire .prw file at once?▼

Yes, you can fix incomplete API documentation blocks across an entire .prw file by scanning the source code to correct existing structures and generating compliant ProtheusDOC blocks for all undocumented elements in a single batch workflow.

Does ProtheusDOC require typed @param and @return tags for AdvPL functions?▼

Yes, ProtheusDOC requires appropriately typed @param and @return tags alongside the mandatory @type tag to ensure AdvPL functions have structured, standard-compliant metadata for generated engineering documentation.

What are the limitations when generating TLPP code documentation?▼

Generating TLPP code documentation requires strict adherence to the ProtheusDOC comment structure and supported optional tags; deviations from identifier rules or missing mandatory @type tags will cause the generated documentation to be non-compliant.

Related Skills

Explore More Software Engineering Skills→
bahayonghangbahayonghang
16

memory-system

Index Markdown notes into a local SQLite vector/full-text index.

Community
Intermediate
zzafergokzzafergok
1

markdown-to-html-skill

Convert Markdown documents to HTML using marked.js, pandoc, gomarkdown, or static site generators.

Community
Intermediate
totvstotvs
115

code-review

Review AdvPL/TLPP sources for security, performance, and Protheus compliance.

Official
Advanced
hiro0218hiro0218
8

code-comment-guidelines

Enforce code-comment guidelines and JSDoc for public APIs.

Community
Advanced