Automated Technical Design Document Generation for Software Components

Resolve Bottlenecks,
Find Innovative SolutionsGenerate Solutions

Solution Overview

Problem

The current software development process is inefficient and error-prone due to the manual conversion of technical design documents from text to code, requiring painstaking reviews and comparisons between design documents and built components, which hinders rapid application development and increases the likelihood of errors.

Innovation Solution

A converter tool is integrated into the design environment to generate a structured technical design document from multiple code files, facilitating automatic conversion and change tracking, reducing the need for manual coding and review processes by providing a unified view of design changes and code fixes.

Engineering Contradictions & Design Principles

VSEngineering Contradiction Analysis

1Reliability

If developers manually code from text documents, then code can be created, but errors increase due to mis-typing and incorrect information

Engineering Contradiction:

Improvecode accuracyVSAvoidreview time

Core Design Contradiction:

ReliabilityVSLoss of time

Solution Approach 1:

The system automatically generates code by copying and transforming information from approved technical design documents into executable code, eliminating manual transcription errors. The converter tool creates accurate code representations directly from the design specifications without human intervention in the coding process.

Inventive Principle:

Principle #26Copying

Solution Approach 2:

The system provides automatic feedback by comparing the generated code against the original technical design document, identifying discrepancies and ensuring accuracy. This feedback mechanism allows developers to verify code correctness without painstaking manual review, reducing both errors and review time.

Inventive Principle:

Principle #23Feedback

2Reliability

If developers manually review code against design documents, then code correctness can be verified, but the process is time-consuming and contrary to rapid application development

Engineering Contradiction:

Improvecode correctnessVSAvoiddevelopment speed

Core Design Contradiction:

ReliabilityVSProductivity

Solution Approach 1:

The system replaces the mechanical manual review process with an automated computational system that compares generated code against technical design documents. This substitution eliminates the need for developers to manually verify each line of code, maintaining correctness while dramatically increasing development speed and aligning with rapid application development goals.

Inventive Principle:

Principle #28Mechanics substitution (Replace mechanical system)

Solution Approach 2:

The converter tool performs self-verification by automatically comparing its generated code output against the source technical design document, identifying and reporting discrepancies without requiring external manual review. This self-service capability ensures code correctness while freeing developers from time-consuming verification tasks.

Inventive Principle:

Principle #25Self-service

3Ease of manufacture

If build occurs in IDE with multiple source files, then software component can be compiled, but tracking changes becomes difficult

Engineering Contradiction:

Improvebuild capabilityVSAvoidchange tracking

Core Design Contradiction:

Ease of manufactureVSLoss of information

Solution Approach 1:

The system introduces an intermediary converter tool that serves as a bridge between the technical design document and the final code build. This intermediary automatically tracks and reports all changes made during the conversion process, providing a clear audit trail of modifications while maintaining the ability to compile multiple source files in the IDE environment.

Inventive Principle:

Principle #24Intermediary (Mediator)

4Measurement precision

If developers compare design document to built component, then changes can be identified, but the task requires painstaking and time-consuming review

Engineering Contradiction:

Improvechange detection accuracyVSAvoidcomparison time

Core Design Contradiction:

Measurement precisionVSLoss of time

Solution Approach 1:

The system replaces the manual comparison process with an automated computational tool that precisely compares the technical design document against the built software component. This automated comparison maintains high detection accuracy for identifying changes while reducing the time required from painstaking manual review to instant automated analysis.

Inventive Principle:

Principle #28Mechanics substitution (Replace mechanical system)

Data Source

PatentUS8103701B2Metadata to technical design review document process

Publication Date: 2012.01.24 ORACLE INT CORP

AI summary

A method includes receiving a user input in a design environment indicating at least one software component for which a technical design document is desired, identifying files in which information associated with the component is located, accessing the information, and formatting the information according to a technical design document template. A system has a design environment for development of software components, and a document generator to automatically generate documentation for the software components on demand. A method to design software components includes producing a design of a software component in a design environment residing upon a computer, selecting the software component for design review, and generating a design document according to a template from the design environment.