Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/ironnysh/docs
Technical writing, documentation, instructional materials, and sample manuals.
https://github.com/ironnysh/docs
airtable api-rest documentation eleventy guide website
Last synced: 20 days ago
JSON representation
Technical writing, documentation, instructional materials, and sample manuals.
- Host: GitHub
- URL: https://github.com/ironnysh/docs
- Owner: ironnysh
- Created: 2021-11-01T15:59:11.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2024-12-13T14:43:29.000Z (about 2 months ago)
- Last Synced: 2024-12-13T16:13:56.233Z (about 2 months ago)
- Topics: airtable, api-rest, documentation, eleventy, guide, website
- Homepage:
- Size: 554 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# 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
- [An overview of relational databases](/assignments/Overview_of_relational_databases.pdf) - sample educational content for a database vendor.
- [A manual for a drone manufacturer](/assignments/Drone_manual.pdf) - sample documentation for an unmanned aerial systems (sUAS) company.
## Project A
I [wrote long-form technical content](https://insights.project-a.com/?s=Ronny+Shani+) 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](https://github.com/WordPress/wordpress-playground/issues?q=mentions%3A%40me+is%3Aclosed) to the project's [documentation site](https://wordpress.github.io/wordpress-playground/developers/), and created two tutorials for the WordPress Developer Blog:
- [Introduction to Playground: running WordPress in the browser](https://developer.wordpress.org/news/2024/04/05/introduction-to-playground-running-wordpress-in-the-browser/)
- [How to use WordPress Playground for interactive demos](https://developer.wordpress.org/news/2024/04/25/how-to-use-wordpress-playground-for-interactive-demos/)
2. **Learn WordPress:** Wrote, edited and reviewed [tutorials](https://github.com/WordPress/Learn/issues?q=assignee%3A%40me%20state%3Aclosed), and helped develop curriculum for end-users, developers, and designers.
3. A manual for a client website (names and details omitted): [README](client_x/README.md), [Airtable API integration](client_x/DEV-DOCS.md).
4. **Mighty** Eleventy Starter: [README](mighty/README.md).
5. WordPress theme and plugins ([WIP](wordpress/README.md)).
6. **Velojiraptor**, generate developer productivity metrics from Jira tickets: [README](https://github.com/project-a/velojiraptor/blob/main/README.md) and an [article I wrote](https://insights.project-a.com/engineering-your-engineers-velojiraptor/) about this open-source project and the motivation behind it.
## Websites
These are some of the websites I’ve designed and developed (2020–)
- [Spitz Magazine](https://spitzmag.de)
- [Insights by Project A](https://insights.project-a.com)
- [Paper Pundits](http://paperpundits.co.uk)
- [Swart Bar Berlin](https://swart-berlin.de)
- [Equitravel](https://equitravel.de)
- [Air Freelance](https://www.air-freelance.com)
- [My site](https://www.ironnysh.com)
- [Pasta della Casa (temporary site)](https://psdc-static.vercel.app)