|
|
Currently unavailable_____________
|
|
Summary Hire someone who translate very complex back-end systems into easily comprehensible visualizations for both technical and non-technical audiences; someone with a proven senior technical writer track record with business analysis and project management for SDLC agile cloud projects. |
|
|
Content Deliverables
API documents, business analysis reports, Confluence space designs and content, end-to-end architectural diagrams, installation and configuration guides, Jira workflows and dashboards, overview manuals, project plans, research papers, release notes, research papers, swim-lane work flows, and white papers. |
Publication example links
- Sys admin configuration and user guide (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)
Selected projects examples
- Technical Information usability reports--2021, 2022
- Data Privacy white paper--2021
- Knowledge management proposal--2019
- Commission report--2019
Large Project Management examples
Personal links
- Linkedin: susankraft
- GitHub account to park docs and code
- Kubernetes For Beginners 2022 link by KodeKloud 2022
- The Complete JavaScript Course 2022: From Zero to Expert! link by Udemy, 2022
- API Technical Writing: JSON and XML for Writers certification link by Udemy. 2020
- Swagger account to build interactive REST API documentation, 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
- SiliCan podcast interview - reflecting on how to live and work in Silicon Valley (YouTube)
My project management examples
" 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
- External LLC announcement
"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
Susan Kraft-Yorke
650-444-1354
Susan.KraftYorke@gmail.com
650-444-1354
Susan.KraftYorke@gmail.com
Technical Writing by Kraft Consulting