About Tech Docs
About Tech Doc
Tech Doc is a Code Shift module that automates the creation of technical documentation directly from the source code in your GitHub repository, which is imported into StackSpot AI.
It analyzes your code and automatically generates structured, ready-to-use documentation for development, architecture, and audit teams.
The documentation is based on information such as dependencies, types, methods, and relationships found within the code files. The generated documentation is delivered directly as a Pull Request (PR) to the repository.
Tech Doc supports several programming languages, including Java, Python, JavaScript, TypeScript, C#, Kotlin, Go, Swift, and Rust, among others.
What are the benefits?
- Automation and efficiency: Save time and effort documenting systems with an automated process;
- Standardization: Ensure documentation follows a unified standard and your company’s best practices;
- Reduced risk: Minimize errors and compliance issues by automating the collection and recording of important code information;
- Security: Integrations with StackSpot are secure and protected against unauthorized access;
- Traceability: All analyses and results are saved with detailed logs, making audits and future queries easier.
Usage examples
See some examples of how you can use the module:
-
Onboarding new team members: Help newcomers understand the system faster with up-to-date documentation aligned with corporate standards.
-
Audits and compliance: Generate clear code reports, making audits easier and meeting regulatory requirements;
-
Refactoring and improvements: Identify dependencies and critical points to modernize or improve legacy systems.
What types of documentation are generated
README.md
An overview file placed at the root of the repository. It is the first point of contact for anyone accessing the project.
- Purpose: Quickly and effectively introduce the project;
- Target audience: Anyone evaluating or starting to use the project;
- Format: Short and to the point, to facilitate getting started;
- Content: What the project is, how to install and configure, how to run locally, basic contribution and support info;
DOCUMENTATION.md (detailed documentation)
A file with complete information about the project, aimed at advanced use and maintenance.
- Purpose: Detail rules, architecture, integrations, and how the project works;
- Target audience: Developers and professionals who need to understand or evolve the system;
- Format: Divided into sections, can be hosted in the product’s GitHub Pages;
- Content: Overview, business rules, architecture, endpoints, data model, tests, observability, security, and more;
Summary of differences
| Aspect | README.md | DOCUMENTATION.md |
|---|---|---|
| Purpose | Introduction and overview | Technical and functional details |
| Length | Short and direct | Extensive and detailed |
| Target audience | Beginners | Advanced users and developers |
| Content | Summary, installation, basic usage | Business rules, architecture, API, data, tests, observability, security |