Jordan Yan · Technical writer
AI and developer documentation
Writing samples that show how I document AI systems and developer tools: what a model is for, where it fails, how to call it, and how to check its answers. Each one follows the conventions of a document type engineering teams use every day.
AI · Model card
SKYSWEEP FOD Detector v2.1
| Condition | Recall | Precision |
|---|---|---|
| Daylight, dry | 0.96 | 0.91 |
| Daylight, wet | 0.92 | 0.86 |
| Night (IR-assisted) | 0.88 | 0.83 |
| Fog / visibility < 800 m | 0.71 | 0.78 |
About these samples. All samples are original work written for this portfolio. Systems, part numbers and data are fictional. No CUI, export-controlled (ITAR/EAR) or proprietary information is included. The exception is the ask-my-docs tool, which is real.
AI documentation
Document AI systems honestly
Model documentation, developer tutorials, API references, and evaluation guides.
- Model cardRunway debris detectionIntended use, condition-level performance, failure modes, and human oversight, mapped to the DoD AI Ethical Principles and the NIST AI RMF.Performance and failure modesSections1Intended use2Performance3Training data4Limitations and failure modes5Responsible AI alignment6Revision history
- TutorialBuild a Q&A bot over your docsExplains retrieval-augmented generation (RAG) and walks through working Python code that calls the Claude API.RAG in Python with the Claude API
- API referenceDocument classification endpointParameters, request and response examples, errors, and rate limits for an AI REST endpoint.Parameters, errors, and rate limits
- Evaluation guideLLM evaluation rubricPass/fail grading criteria, test-set design, and reporting results by question type for a documentation assistant.Grading criteria and test-set design
Defense & aerospace
Write for high-stakes systems
Technical manual and interface documentation that follows military standards.
- Maintenance procedureUAS propeller replacementA MIL-STD-40051-2 work package with MIL-STD-38784B WARNING, CAUTION, and NOTE advisories, prerequisites, and verifiable steps.MIL-STD-40051-2 work package
- Interface control documentTelemetry messageByte-level message layout with units, scale, ranges, enumerations, and requirements traceability.Byte layout, ranges, and traceability