https://github.com/interledger/writer-tech-test
https://github.com/interledger/writer-tech-test
Last synced: 3 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/interledger/writer-tech-test
- Owner: interledger
- Created: 2023-05-01T19:53:39.000Z (about 3 years ago)
- Default Branch: main
- Last Pushed: 2025-09-02T15:49:52.000Z (9 months ago)
- Last Synced: 2025-10-09T16:17:23.549Z (8 months ago)
- Size: 4.88 KB
- Stars: 0
- Watchers: 1
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Interledger Technical Writing Assignment for the [Technical Writer Role](https://CHANGEME)
## Logistics
This assignment is intended to be done at home. **You have three days to complete it.**
We've purposefully kept instructions to a minimum. After we review your submission, we'll schedule a video call where we can discuss your choices and deliverables.
## Instructions
Document the [icanhazdadjoke](https://icanhazdadjoke.com/api) REST API by creating the following resources:
* An overview (no more than a single page) that outlines the concepts and functionality of the API
* An OpenAPI specification for the “Search for dad jokes” endpoint
* A 500 - 1,000 word step-by-step tutorial for using the API endpoint in the programming language of your choice
Note that the API has no authentication requirements, supports multiple response formats, and requires a user agent.
You can use any resources you like. You are encouraged to use any libraries that you find helpful.
*Please do not share your solution to this assignment with others.*
## Requirements
* The documentation set must be written in Markdown.
* You must use a static site generator to render the documentation. If you need a place to host your content, GitHub Pages allows you to serve a static website directly from your repository.
### Example Usage of the API
```sh
$curl -H "Accept: application/json" -H "User-Agent: ILF Test (https://github.com/username/repo)" https://icanhazdadjoke.com/search
```