ADK code unit guide

This skill creates a detailed developer guide for new or updated code file or direct code input. The guide it generates is meant to explain the code to a developer who wants to use it in an application, but with a higher level of technical detail than what would appear in published developer documentation. Similar to a unit test, a unit guide provides generated, granular-level documentation for a unit of code, without worrying about bloating the actual developer documentation with too many details.

Input

• Code files containing new functionality
• Code unit tests (optional)
• Code design files (optional)
• Names of new methods and classes (optional)

Analysis

• Review the code design files, if provided. Make note of:
  • Purpose and intended use of the new or updated code units
  • Classes that depend on the new or updated code units
  • Additional dependencies required by the new or updated code units
  • Limitations of the new or updated code units
• Review specified code file for changes and named methods, if provided.
• Determine what classes and code files may depend on the new or updated code units.