I fix software engineering docs
  • home
  • portfolio
    • Doc types
  • about
    • contact >
      • External resources
      • Susan's resume
  • Podcast

Technical document solutions

This page lists documentation examples sorted by documentation types.
All docs are posted here are anonymized, outdated, or in public use.
Picture

​Guides and flowcharts

My examples​
  • Scientific setup and app user guide↗: Thermo Fisher (PDF partial)
  • POS Payment API; conceptual documentation for clients ↗: 
    Anonymized (PDF partial)
  • ​New card developer API quick access guide↗: 
     from personal doc stash ​( public page, full doc)

Picture

​Policies

​My examples​
  • Access Control and Security Policy ↗: Anonymized  (PDF sample)
  • Change Management Policy ↗: Anonymized  (PDF sample)
  • Compliance, security, classification, data governance & risk management policy↗: Anonymized  (PDF sample)

Picture

​Research and White papers

  • ​Data privacy white paper↗: Anonymized  (PDF partial doc) 
  • IA models with ROI and hidden costs use case↗:  from personal doc stash ​ (PDF full doc)
  • IA guardrails that transform fragmented docs↗:  from personal doc stash PDF full doc)
  • Knowledge base platform governance proposal↗: Anonymized (PDF full doc)
  • White paper template↗:  from personal doc stash (PDF full doc)

​Client product types


Cloud & Big Data Platform
  • Next-gen computational platform (Citadel Securities)
  • Cloud-based API marketplace  (BNY, Fiserv)
  • Cloud deployment and support content (Plume Design)

APIs & Financial Systems
  • B2B payment APIs: SWIFT, onboarding workflows (BNY)
  • Treasury and payment services platforms (BNY)
  • Secure payment processing systems (BNY, Fiserv)
  • End-to-end order device restaurant networks (Presto commercial automation)

Compliance & Security
  • GDPR and CCPA compliance documentation at Intuit
  • Hardware vulnerability tracking database (Apple)
  • Secure-encryption network products (Cylink)

Enterprise & Developer Tools
  • Information architecture for enterprise software (SAP, Thermo Fisher Scientific, and Amdocs)
  • Java R&D documentation and developer tools (Oracle)
  • Jira administration and project tracking systems (Adap.tv, and Merchant e-solutions)

Networking & Telecom
  • ATM-over-IP documentation suite (Zeitnet)
  • Fiber optics telephony systems (Raynet)
  • Innovation programs and white papers for network solutions (Infoblox)
Picture

API docs

My examples
  • API payment services products: Initiate ACH Credit Transfer example ↗: BNY (Partner APIs public website)
    (I wrote RESTful API specifications with code samples, payload schema definitions, etc.)
  • API banking card services: Card Developer > Update limits ↗:
    Fiserv (I migrated the Partner APIs public website from HTML to markdown and wrote onboarding pages.)
Picture

Generative AI

​My examples​
  • Tech style guide for ChatGPT↗:  from personal doc stash ​ (PDF full doc)
  • ​IA and auto-generating API documentation from code↗:  from personal doc stash ​ (PDF full doc)
​

Picture

​Program and project management

  • Paper: Initial report on document control center↗: Anonymized  (PDF full doc)
  • Paper: How to manage a new API site in GitHub↗: Anonymized (PDF partial)
  • MS Project: National conference: setup, run, shutdown plan↗: regional conference (PDF partial)
  • Excel: Technical library tracking : end-to-end assessment↗: Zen (image)
  • Dashboard: Program manage-design-dev-train↗: (Anonymized PDF full doc)
  • Paper: Squad planning cycle with jira↗: Anonymized  (PDF sample)

Picture

Persuasive docs

  • ROI on information architecture↗:  from personal doc stash (PDF)
  • Silicon Valley’s waves of change↗:  from personal doc stash (PDF)
  • Strategic market opportunities↗:  outdated, Infoblox (PDF)
Picture

I'm here to help.

By using industry best practices combined with internal-user documentation research, I can design information architecture systems for your document control ease of use.

SOLUTIONS

- API and SDK
- Guides and flowcharts
- Generative AI
​​- Project management docs
​- Policy docs
- Research and white papers
​- Persuasive docs

Principal

About
Menu

Support

Contact
Request a 30-minute appointment
FAQ
Picture
Picture
© COPYRIGHT 2025. ALL RIGHTS RESERVED.
  • home
  • portfolio
    • Doc types
  • about
    • contact >
      • External resources
      • Susan's resume
  • Podcast