|
|
Information Architect | Sr. Technical Writer
Expertise in docs-as-code workflows and developer API documentation. Bonus: Jira and project management expert. |
|
When you can't take a chance with your technical documentation, then you may need:
Send inquiries to susan.kraftyorke<at>gmail.com or call +1-650-444-1354
|
|
Content Deliverables
An evergreen documentation repository for API documentation, technical information documents, release notes, white papers, and analysis reports.
Product documentation includes:
Confluence space designs and content, end-to-end architectural diagrams, how-to guides, installation and configuration instructions, Jira workflows and dashboards, overview manuals, project plans, research papers, Swagger page updates, swim-lane/logic workflows, and white papers.
Scroll through samples on the visual samples page.
An evergreen documentation repository for API documentation, technical information documents, release notes, white papers, and analysis reports.
Product documentation includes:
Confluence space designs and content, end-to-end architectural diagrams, how-to guides, installation and configuration instructions, Jira workflows and dashboards, overview manuals, project plans, research papers, Swagger page updates, swim-lane/logic workflows, and white papers.
Scroll through samples on the visual samples page.
Fun facts
- Author and coach of A Practical Guide to Becoming a Technical Writer.
- Certified in project management, API technical writing, JavaScript, JSON, Scrum Master, and Scrum Product Owner. Holds an MS degree in applied physics.
- Registered and built my first website in 1996.
- Recent brag-worthy fintech projects:
- API writer for new payments site (BYN)
- Information Architect for large data modeling platform (Citadel Securities)
- API writer for new payments site (BYN)
- My home office is in New York’s Hudson Valley.
- I became a technical writer while living in Palo Alto, the heart of Silicon Valley. I honed my skillset while navigating the evolution of technology—from network backbones to cloud computing and AI.
Still reading? Great, because there is more to read if you keep scrolling.
The last section has my personal links to stuff I occasionally to refer to. I posted this set for me and other tech writer pals.
Extended publication samples links
- Admin guide quick start (PDF originally in Word)
- API payment services (public website)
- API banking card services (public website)
- Sys admin configuration and user guide (PDF originally in Word)
- Payment flow APIs (PDF originally in Word)
- Persuasive white paper on strategic opportunities (PDF originally a Google doc)
- Knowledge base platform governance (Google doc format)
- Scientific set up and app user guide (PDF originally in FrameMaker)
- Portfolio of systems and apps overview (PDF originally in Word)
- Diagrammatic end-to-end correction example (PowerPoint slides showing improvements of a messy and end-to-end architectural diagram)
- Change management document (Google doc format)
- API reference doc example + source (PNG format)
- Alternative sample page, see visual portfolio page
Selected projects samples
- Data privacy white paper--2020
- Knowledge management proposal--2019
- Commission report--2019
- Proteomics research mass spectrometry analysis guide--2008
Large project management samples
Glad to see you're hanging in there to the end!
Next up are links I keep for myself, as after a while these things can drop off the top of my memory stack.
Next up are links I keep for myself, as after a while these things can drop off the top of my memory stack.
Personal links
- Linkedin: susan-kraftyorke
- GitHub account: class work and a few example files
- Postman account - Udemy class, in process
- JoAnn Hackos select books:
- "Information Development: Managing Your Documents Projects ": the first and canonical Tech Pubs planning resource
- "Information Architecture Technical Documentation": an update and expanded version of the previous doc
- My doc plan sheets example type 1, example type 2
- IIBA training for CBAP certification 2023: Professional certification for individuals with extensive business analysis (BA) experience
- Ethereum and Solidarity: The complete developer's course link by Udemy, 2023
- MadCap Flare Introductory Training link by Madcap Flare, in process
- The Complete JavaScript Course certification 2023: From Zero to Expert! link by Udemy, 2022
- API Technical Writing: JSON and XML for Writers certification link by Udemy, 2020
- ScrumMaster (CSM) certifications by Scum Alliance and Platinum Edge, 2019
- REST API Reference documentation for Writers certification link by Udemy (my class notes)
- Learn Swagger and the Open API Specification link by Udemy, 2020
- Python and API for Technical Writers by Udemy, 2020
- Scrum Product Owner Certification by Udemy, 2022
- Kubernetes For Beginners 2022 link by KodeKloud, 2022
- SiliCan podcast interview - a longish podcast, reflecting on living and working in Silicon Valley (YouTube). It's a time capsule for me.
top
"I break down technical puzzles then put those solutions into easy-to-understand results."
External Resources
- Managing your documentation projects
- Google PM apps
- Google Docs community forum
- Icon bank
- API docs explained
- API Basics
- Swagger—OpenAPI Specification
- SwaggerHub—account needed
- Markdown Cheatsheet
- JSON check and formatter page
- XML check and formatter page
- Confluence Markup doc page
- Readme.io—for markdown doc in Github repos
- Where to Start with Atlassian
Authoring tools: Atom, VS code, Notepad++, Confluence, ePublisher, FrameMaker, Oxygen, Google doc, HTML, MacDown, RoboHelp, Swagger, Word
Graphics and video tools: Draw.io, Gliffy, LucidChart, mp3DirectCut, SnagIt, Paint, Photoshop, Premiere Elements, Visio
Graphics and video tools: Draw.io, Gliffy, LucidChart, mp3DirectCut, SnagIt, Paint, Photoshop, Premiere Elements, Visio
- Draw.io Diagrams for Confluence (now called "diagrams.net") – A popular and free diagramming tool that integrates well with Confluence, allowing you to create flowcharts, swimlanes, and other visual diagrams.
- Gliffy Diagrams for Confluence – Another well-integrated tool with an intuitive drag-and-drop interface for creating swimlane diagrams and other visuals.
- Lucidchart Diagrams for Confluence – If your team already uses Lucidchart, its Confluence integration allows you to embed and edit swimlane diagrams easily.
"The destiny of the world is determined less by the battles that are won and lost, but by the stories it loves and believes in."
― H. C. Goddard, author
― H. C. Goddard, author
Technical Writing by Kraft Consulting