Astro Starlight
The core static site generator and documentation framework, providing blazing-fast navigation, full-text search, and accessible layouts.
About This Knowledge Base
Documentation & Architecture Philosophy
Section titled “Documentation & Architecture Philosophy”I am a software engineer and technical writer. My philosophy is simple: write for the reader, not the writer.
Every piece of documentation, runbook, and architectural specification I create starts with three critical questions:
- Who will read this (
Developer,Support Engineer,Architect,Content Editor, orAI Agent)? - What is their exact technical proficiency and context?
- What concrete task must they accomplish immediately after reading it?
Good technical documentation should reduce cognitive load, provide clear paths to success, and anticipate exact production bottlenecks. Whether writing OpenAPI schemas for developers, SOP debugging runbooks for support engineers, high-level architecture designs for product leads, or machine-readable context for AI coding agents, clarity and precision are the core of my approach.
Technical Knowledge Hubs
Section titled “Technical Knowledge Hubs”To structure complex engineering documentation across diverse domains, this knowledge base is organized into three primary engineering hubs:
- 🎯 Developer Docs & API (Offline): Technical specifications, OAuth 2.0 sequence flows, JSON request/response schemas, and AWS EC2 onboarding tutorials for software engineers, API integrators, and developer enablement.
- 🎯 Troubleshooting & Runbooks (Offline): Actionable Standard Operating Procedures (
Symptom → Diagnosis → Fix), Canvas LMS integration error resolutions, distributed log tracing, and local SSL bypass runbooks (thisisunsafe) for support engineers, SREs, and operations teams. - 🎯 Architecture & Project Logic (Offline): High-level system decomposition, Canvas LMS + AWS infrastructure diagrams, mathematical algorithm modeling (
KaTeX), and trade-off analysis across live production deployments for system architects, engineering leads, and technical managers.
Competency Map
Section titled “Competency Map”This hub demonstrates a comprehensive spectrum of technical competencies across both modern and legacy engineering architectures:
| Competency Domain | Featured Documentation Asset | Core Engineering Competency Demonstrated |
|---|---|---|
| API Specifications & Sequence Flows | Developer Docs & API (Offline) | OpenAPI/REST payload schemas, cURL/fetch examples, and Mermaid.js sequence diagrams. |
| Operational Troubleshooting & Runbooks | Troubleshooting Hub (Offline) | Actionable SOPs (Symptom → Diagnosis → Fix) across Canvas LMS and legacy Perl systems. |
| System Architecture & Logic Decomposition | Architecture Hub (Offline) | High-level system design, trade-off analysis, and mathematical algorithm breakdown. |
| Complete Application Suites | 3D Portfolio, Raised Church | Multi-audience documentation for live production web applications (sharonwang.me & raisedchurch.com). |
| Legacy System Knowledge Capture | TMS (Offline for Sanitization) | Institutional onboarding guides and debugging runbooks for a Perl 5 academic platform. |
| AI/Automation Engineering Docs | Raised Church AI Guide | Machine-readable context files and structured instructions optimized for LLM consumption. |
| Academic & Mathematical Writing | Articles, Logic Case Study (Offline) | Peer-reviewed research, stemmatic theory, and formal LaTeX equation modeling. |
Tools & Stack
Section titled “Tools & Stack”This hub is built with modern documentation and publishing tooling:
MDX & Starlight Components
Embeds interactive elements, Tabs, Steps, Aside callouts, and structured CardGrid layouts directly inside markdown.
KaTeX Mathematical Rigor
Powered by remark-math and rehype-katex to render formal mathematical equations ( and distance matrices) cleanly across all documents.
Mermaid.js Diagrams
Generates complex architecture diagrams, OAuth sequence flows, and system pipelines directly from code syntax.
Documentation Methodology
Section titled “Documentation Methodology”Diátaxis Framework
Every page in this knowledge base is structured according to the Diátaxis framework — a systematic approach to documentation authoring that classifies content into Tutorials, How-to Guides, Reference, and Explanation based on user needs. This ensures each document has a clear purpose and appropriate tone for its audience.
Prose Linting with Vale
All documentation is linted with Vale.sh using the Google Developer Documentation Style Guide and Microsoft Writing Style Guide as baselines. This enforces consistent tone, terminology, and clarity across every page — the same tooling used by AWS, NVIDIA, GitLab, and Docker.
Get in Touch
Section titled “Get in Touch”If you value rigorous, production-grade technical documentation and clear engineering communication across systems, let’s connect:
- Live Personal Portfolio: sharonwang.me
- GitHub Repository: github.com/sharonwang554
- Live Church Platform: raisedchurch.com