Where to find someone that enjoys writing API documentation?
Hey fellow hackers,
one of my first posts on here, so let me know if there are any problems ;) Our product is an API that people can use to fetch various IP/DNS/WHOIS/Company related information.
Our documentation was written by developers in the past, but it's not as extensive as we want it to be. (See https://securitytrails.com/corp/apidocs) The text is totally fine for API reference, but we would like to add more to it. The first step is taken and we are putting the Docs + API reference on readme.io - however, we want to create a workflow where the documentation and reference is constantly updated with our new features and new examples etc. are added.
Now the main question: Do you know any freelancers that enjoy writing API documentation? We are looking for someone that regularly uses APIs himself, enjoys security related projects and has good technical writing skills in English.
Any recommendations/info/feedback greatly appreciated!
Hello German,
I looked at your API docs and found them to be quite nice. I am not sure what more you are looking to add...
But.. I would recommend just having your developers make self documenting comments in their code(doc strings and such), then use one of the MANY frameworks that auto generate a Swagger 2.0 spec. From there you can use travis CI or some other build tool in order to auto push your auto generated API documentation to the cloud.
Another good one is https://readthedocs.org/
I create and manage this pipeline in my full time job + side projects. Plus the person who writes the code usually understands the API endpoints better than a person who just uses them or only writes down what they are told.
Hi Taylor,
thanks for your feedback! Much appreciated :)