When you want ...
... then write to susan.kraftyorke<at>gmail.com or call 650-444-1354 |
Content Deliverables
API documents, business analysis reports, Swagger page updates, Confluence space designs and content, end-to-end architectural diagrams, installation and configuration guides, Jira workflows and dashboards, overview manuals, PowerPoint presentations, project plans, research papers, release notes, research papers, swim-lane work flows, and white papers.
You can scroll through samples on the visual samples pages.
API documents, business analysis reports, Swagger page updates, Confluence space designs and content, end-to-end architectural diagrams, installation and configuration guides, Jira workflows and dashboards, overview manuals, PowerPoint presentations, project plans, research papers, release notes, research papers, swim-lane work flows, and white papers.
You can scroll through samples on the visual samples pages.
Fun facts
|
Core skills
|
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
"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
This website uses marketing and tracking technologies. Opting out of this will opt you out of all cookies, except for those needed to run the website. Note that some products may not work as well without tracking cookies.
Opt Out of Cookies