doc-sync-automation

Doc Sync Automation

Keep documentation synchronized with code changes automatically.

When to Use

• Code changed and docs need updating
• Generating API documentation from code
• Creating or updating README files
• Keeping inline comments/JSDoc current
• Setting up documentation automation

Documentation Types

Type	Location	Sync Trigger
Inline (JSDoc/TSDoc)	In code files	Code changes
API Reference	/docs/api/	Endpoint changes
README	Root or feature folders	Feature changes
Changelog	CHANGELOG.md	Any release
Architecture	/docs/architecture/	Structure changes

Inline Documentation (JSDoc/TSDoc)

AI Prompt for JSDoc Generation

Generate JSDoc comments for this function:

```typescript
async function createUser(
  email: string,
  password: string,
  options?: { role?: string; sendWelcome?: boolean }
): Promise<User> {
  // implementation
}

Include:

• Description
• @param for each parameter
• @returns description
• @throws if applicable
• @example usage

### Generated Output
```typescript
/**
 * Creates a new user account with the specified credentials.
 *
 * @param email - The user's email address (must be unique)
 * @param password - The user's password (min 8 characters)
 * @param options - Optional configuration
 * @param options.role - User role, defaults to 'user'
 * @param options.sendWelcome - Send welcome email, defaults to true
 * @returns The newly created user object
 * @throws {ValidationError} If email is invalid or password too short
 * @throws {DuplicateError} If email already exists
 *
 * @example
 * const user = await createUser('[email protected]', 'securepass123');
 *
 * @example
 * const admin = await createUser('[email protected]', 'adminpass', {
 *   role: 'admin',
 *   sendWelcome: false
 * });
 */

Batch Update JSDoc

Update JSDoc for all exported functions in this file.
Keep existing descriptions if accurate, update if code changed.

```[paste file content]```