Skip to content
/ docs Public

Technical writing, documentation, instructional materials, and sample manuals.

Notifications You must be signed in to change notification settings

ironnysh/docs

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

26 Commits
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Documentation and technical content

Besides documenting my own web projects, In the past, I’ve edited and consulted on developer’s API documentation and user manuals. Throughout my career, I’ve written and edited countless articles, tutorials, and technically-oriented blog posts.

I completed API documentation and DITA courses, and authored and maintained style guides and templates.

Adjust

I created the developer documentation for one of the company's SDKs. On the user-end side, I created documentation for a new feature, and restructured and wrote a fundamental chapter designed to reduce support calls.

My work involved working with a cross-functional team of engineers, product managers, and support experts.

I've also peer reviewed technical content written by teammates, and worked on preparing a combination of markdown templates and VS Code snippets to optimize workflows.

Manuals and learning materials

Project A

I wrote long-form technical content and supported the engineering, data, and product teams with developing, editing, and writing technical content. As part of my responsibilities, I’ve developed and implemented the content strategy for the in-house tech blog. I’ve also co-authored the firm’s style guide and tone of voice, wrote manuals for non-technical users of the site, and created extensive documentation of the custom WordPress theme and plugins I developed.

Sample work

  1. WordPress Playground: I contributed to the project's documentation site, and created two tutorials for the WordPress Developer Blog:
  2. Learn WordPress: Wrote, edited and reviewed tutorials, and helped develop curriculum for end-users, developers, and designers.
  3. A manual for a client website (names and details omitted): README, Airtable API integration.
  4. Mighty Eleventy Starter: README.
  5. WordPress theme and plugins (WIP).
  6. Velojiraptor, generate developer productivity metrics from Jira tickets: README and an article I wrote about this open-source project and the motivation behind it.

Websites

These are some of the websites I’ve designed and developed (2020–)

About

Technical writing, documentation, instructional materials, and sample manuals.

Topics

Resources

Stars

Watchers

Forks