Entrepreneurship · Freelancing

Showing the Documentation for the API I've Developed

Tri R.A. Wibowo Co-founder and Backend Developer of Shipper; Node.js Fanatic

September 27th, 2017

Hi :)


I have this weird idea to show the documentation on API I've developed for a startup to potential clients as a part of my portfolio. Is such an idea ethical?

Scott McGregor Advisor, co-founder, consultant and part time executive to Tech Start-ups. Based in Silicon Valley.

September 27th, 2017

It depends. If the documentation on the API is published, there should be no reason you can't share the public document and tell someone you wrote it. If the documentation was written for someone else (work for hire), and is private, proprietary or confidential, it may be governed by an NDA.


In that case, you should request permission from the person you did the work from to share some or all of this documentation as an example of your work product when job hunting or client hunting.


I have created many work for hire documents and products and regularly ask clients and employers if I can share some or all of that work. I have always received permission to share something for these limited purposes, though it is not infrequent that I am requested to show only a portion of the work, or to redact sensitive things.


As a hiring manager I have frequently asked writers, programmers and artists to show me examples of both their finished work, and the specs they started with.

Lisa Retief Experienced software engineering leader and entrepreneur.

September 27th, 2017

Is it a public or private API? If it is public, no problem. If it is private, you need to get their permission.