Soroush Neyestani

Software Engineer

Application Architect

Enterprise Application Developer

Technical Author & Educator

Office VBA in Persian — Versioned Documentation Platform & 12-Volume Reference Series

Overview

Office VBA in Persian is a planned next-generation Persian documentation and publishing platform for the Microsoft Office VBA ecosystem.

The original idea was straightforward: translate the Office VBA documentation manually and organize it into twelve Persian books. That approach exposed a serious maintenance problem: a documentation corpus this large can change while the translation is still being produced.

The project was therefore redesigned as a documentation-engineering system rather than a one-time translation effort.

The target architecture starts from the official source-controlled Microsoft VBA documentation, records the source revision, applies a controlled translation workflow, validates code and document structure, and maintains one canonical Persian source tree.

That source is intended to generate two coordinated outputs:

  • a continuously maintainable online Persian reference;
  • a twelve-volume editioned technical book series.

The Core Engineering Problem

The difficult part is not translation alone.

The platform must keep several moving parts synchronized:

  • upstream Microsoft documentation;
  • source revisions;
  • Persian terminology;
  • API identifiers;
  • executable VBA code;
  • links and cross-references;
  • online publishing;
  • print publishing;
  • licensing and attribution;
  • and future upstream changes.

The central principle is:

Documentation should be treated as a versioned software artifact.

Twelve-Volume Architecture

The planned publication structure is:

  1. Office VBA Core
  2. Access VBA
  3. Excel VBA
  4. Office for Mac VBA
  5. Outlook VBA
  6. PowerPoint VBA
  7. Project VBA
  8. Publisher VBA
  9. Visio VBA
  10. Word VBA
  11. VBA Language Reference
  12. Office Library Reference

Each volume has its own editorial scope, but all of them share the same canonical translation infrastructure.

Source and Versioning Model

The project is designed around the official MicrosoftDocs/VBA-Docs source tree rather than arbitrary page scraping.

A translated page should be traceable to an exact upstream revision.

Conceptually:

Source File
├── upstream path
├── upstream revision
├── translation status
├── terminology status
├── validation status
└── publication targets

This allows the system to determine which Persian pages are current, outdated, newly added, removed upstream, or waiting for review.

Translation Pipeline

The intended translation pipeline protects technical semantics.

The translation model should:

  • preserve API names;
  • preserve object, method, property and event identifiers;
  • preserve code blocks;
  • preserve parameter names;
  • translate explanatory prose;
  • use an approved Persian glossary;
  • avoid inventing functionality.

A canonical glossary and translation-memory layer are intended to keep terminology consistent across all twelve volumes.

Code and API Preservation

VBA code must remain executable.

For example:

Sub Example()
    Range("A1").Value = "Hello"
End Sub

should not be linguistically rewritten.

The pipeline should also detect accidental code mutations and prevent Persian characters from entering identifiers.

Quality Assurance

The project is designed around deterministic QA rather than trusting fluent output.

Checks can cover:

  • Markdown structure;
  • front matter;
  • heading hierarchy;
  • code fences;
  • links;
  • tables;
  • API-token preservation;
  • terminology;
  • Persian typography;
  • residual untranslated prose;
  • and source-revision metadata.

One Canonical Source, Multiple Outputs

The website and books should not be maintained independently.

The planned build system uses one Persian source tree to generate:

Canonical Persian Source
├── Online HTML
├── PDF
├── EPUB
├── Print Manuscript
└── Search Index

This prevents the website and books from drifting apart.

Online Platform

The online reference is intended to provide:

  • hierarchical navigation;
  • full-text search;
  • application filtering;
  • object / method search;
  • code examples;
  • source revision information;
  • translation status;
  • and stable URLs.

A strong search model would support both Persian terminology and official English API identifiers.

Printed books represent frozen editions.

Each edition should point to a specific upstream snapshot so that the published version remains reproducible even while the online reference continues to evolve.

The publishing workflow also needs to handle the typography challenge of:

  • Persian RTL prose;
  • English API names;
  • LTR code;
  • URLs;
  • tables;
  • and mixed-direction technical text.

Licensing and Attribution

The architecture includes attribution and licensing as part of the publishing workflow.

Public releases should identify:

  • the source repository;
  • the relevant source revision;
  • the documentation license;
  • the independent Persian translation/adaptation;
  • and any original Persian educational additions.

The branding must remain clearly independent and must not imply Microsoft endorsement.

Professional Relevance

This project demonstrates work across:

  • Documentation Architecture
  • Translation Engineering
  • LLM Pipeline Design
  • Version Synchronization
  • Technical QA
  • Build Automation
  • Technical Publishing
  • VBA / Office Object Models
  • Localization
  • Licensing-Aware Publishing

Website Version

Building a Persian VBA Reference That Can Stay Current

My first plan was to turn the Microsoft Office VBA documentation into a twelve-volume Persian book series manually.

The problem was not the size alone. The real problem was update latency: by the time a large documentation corpus is translated and formatted manually, the original source can already have changed.

I therefore redesigned the project around a version-aware documentation architecture.

The system is intended to track the official source repository, preserve exact upstream revisions, protect VBA code and API identifiers during translation, enforce shared terminology, validate output automatically and generate both the online reference and the twelve books from one canonical Persian source.

The result is not intended to be a static translation archive. It is a maintainable publishing system in which documentation changes can be detected, updated and republished without rebuilding the entire corpus from the beginning.

Compact Portfolio Card

Office VBA in Persian
VBA · Documentation Engineering · Localization · Technical Publishing

A version-synchronized Persian documentation platform designed to transform the official Office VBA source tree into both a continuously maintainable online reference and a coordinated twelve-volume technical book series.

Suggested SEO Metadata

SEO Title: Office VBA in Persian — Versioned Documentation & 12-Volume Series
Meta Description: A planned version-aware Persian Office VBA documentation platform combining source synchronization, controlled translation, automated QA, online reference publishing and a coordinated 12-volume book series.
Suggested Slug: /portfolio/office-vba-persian-documentation-platform

Portfolio Status

This entry represents one part of the planned Office VBA in Persian documentation and publishing system. The current project status is in development / planned full rebuild. It should not be presented as a completed published volume until the corresponding source corpus has been translated, validated, assembled and released.

Shared Publishing Architecture

All twelve volumes are designed to come from one canonical Persian source tree rather than being maintained as unrelated books.

Official Microsoft VBA Documentation
        ↓
Versioned Source Snapshot
        ↓
Translation + Terminology Control
        ↓
Structural / Code / Link QA
        ↓
Canonical Persian Source
        ↓
Online Reference + Editioned Books

The architecture is intended to preserve API identifiers and executable VBA code, track upstream revisions, and support incremental updates when the official documentation changes.

Accuracy and Attribution Boundaries

  • The source project is an independent Persian translation/adaptation and publishing initiative.
  • It must not imply Microsoft endorsement.
  • Official API names, product names and code identifiers remain unchanged where required.
  • Documentation attribution and applicable licensing notices must be preserved.
  • Educational commentary added in Persian should remain clearly distinguishable from translated Microsoft reference content.
  • This portfolio page describes the planned architecture and publication scope; it does not claim that the complete volume has already been released.

Suggested Portfolio Taxonomy

Category: Publications

Core Tags: VBA · Microsoft Office · Technical Documentation · Digital Publishing · Localization

Office VBA in Persian — Versioned Documentation Platform & 12-Volume Reference Series