Live data from Hacker News

DeveloperHub.io: Create beautiful product documentation, hassle-free

developerhub.io

11–20 of 70 posts

Re: DeveloperHub.io: Create beautiful product documentation, hassle-free

#11

Earlier quoted context omitted.

ah nevermind too much monies

$39 a month for beautiful documentation, and once they finish API with Swagger support it is great value. I can see for open source projects that don't generate revenue the price being expensive, but as a SaaS business owner the pricing feels just right.

You know, I think normally the common sense buy-vs-build wisdom would win out here, but this is truly an offering that is trivial to build out and is aimed towards an audience that can forgive the common UX perils of home built solutions.

Not to mention there are great off the shelf open source alternatives that work FANTASTIC and have most of the offerings listed on this SaaS product. I use https://github.com/Rebilly/generator-openapi-repo which took literally minutes to setup.

Here's my workflow:

* I type "npm start" in my docs project repo and load the tab that contains the syntax-highlighting enabled editor window in the browser.

* I modify my swagger.yml to update my documentation in the editor

* I use the dev preview tab (a separate node web dev server on another port) to see how the documentation looks

* Once I'm satisfied, I commit and push everything into the git backed repo.

My api docs exist on a github page so I don't even need to worry about hosting. As soon as I push my changes, they are live on my docs site. I've setup a CNAME record to point apidocs.mycompany.com to the github page and presto, I have a whitelabeled documentation site that I can update on a dime, for free, with absolutely zero monthly charge.

I have a hard time understanding how even the most elementary of developer couldn't manage to do this. I can't imagine it takes more than two hours for a mediocre web developer to get running (at most).

At what point do you have the financial responsibility to reasonably consider implementing an elementary task yourself instead of SaaSifying yet another area of your company? $49/mo is less than my hourly rate, in theory, but doing it once means one less SaaS bill at the end of the month.

In what use case is buying this product justifiable?

Re: DeveloperHub.io: Create beautiful product documentation, hassle-free

#12
post #10

SaaS-ifying your docs seems risky to me. Writing documentation is a big investment and startups tend to come and go ("it's been an incredible journey"). $39/mo is much more than what it costs to self-host Confluence, which for all its flaws at least leaves you in control of your data and is super extensible. Improve the data portability story and it'd be a lot more attractive. Additionally the actual docs and demo si…

Agree. $40/mo is a bit steep for just documentation and also when VuePress exists for... free.

Re: DeveloperHub.io: Create beautiful product documentation, hassle-free

#13

Looks great, but VuePress is just so simple.

I literslly just launched our startups product documentation site with VuePress and had a great experience. - host the git repo on github - use github pages to manage the web hosting, it even gives you SSL for free - VuePress generate beautiful docs too and has a super low learning curve.

The one issue with the above setup is that it’s just too techy for the average person. I was looking for freelancers to hire to help me buildout the documentation, annotated images etc. The average writer is far more used to WYSIWYG editors like Word and would have no idea how to use Git. If this solution allows non tech users to collaborate on the documentation, they may be on to something.

Re: DeveloperHub.io: Create beautiful product documentation, hassle-free

#14

When I started ReadMe, I tried to buy the domain developerhub.io to use as name... I was inspired by StatusPage.io. But alas, I couldn't get it and went with ReadMe.io instead :) What do you see as the main differentiators of DH compared to ReadMe? (Zaid, feel free to contact me! My email is in my profile)

Oh hey, I recognise your name :)

I just want to say thanks for your efforts on swagger-inline!

I was actually looking for a tool just like it earlier this year. The project I was using it with was in Python so unfortunately we couldn't justify adding a dependency on Node just for one tool.

It did inspire me to write my own similar tool from scratch, compatible with OAS 3.0. Unfortunately it's not open source just yet but I've got most of the sign off I need so hopefully I can release it into the wild sometime.

In our particular use case, we have a series of microservices that inherit from a shared codebase (controllers etc). Funnily enough, I ran into trouble trying to document controller routes bceause... there were none! They were all inherited, haha.

Anyway, I'm impressed that you're still across a number of repos! Maybe Readme is a bit smaller than I figure assumed?

Re: DeveloperHub.io: Create beautiful product documentation, hassle-free

#15
post #10

SaaS-ifying your docs seems risky to me. Writing documentation is a big investment and startups tend to come and go ("it's been an incredible journey"). $39/mo is much more than what it costs to self-host Confluence, which for all its flaws at least leaves you in control of your data and is super extensible. Improve the data portability story and it'd be a lot more attractive. Additionally the actual docs and demo si…

> SaaS-ifying your docs seems risky to me.

It strikes me as a really, really bad idea. Besides the obvious lock-in issues, I've found the only hope of keeping documentation uptodate is to either generate it from the code or keep it checked it in git besides the code.

What's really needed are (1) authoring tools that can produce decent documentation (ideally as docbook XML or maybe asciidoc) for checkin and (2) product guys who are willing to write docs for features before or during feature development and (3) translation services that can actually do a decent job between the big three business languages (English, Mandarin, Spanish).

It's frustrating that 1, 2, and 3 are so very hard to find. Many products live or die by their lack of documentation, but there don't be seem any simple solutions here.

Re: DeveloperHub.io: Create beautiful product documentation, hassle-free

#16
First of all this looks pretty nice. I'm a docs nerd and as a whole I like this.

However ... It's slow. Docs should be static HTML. I should not ever wait for text content. If you want to async load some images or embeds that's fine, but I was waiting for the title to load!

As an aside I recently had a nice experience making a static docs site using Nuxt and Vue. Nice combination of dynamic development and fast performance in production.

Re: DeveloperHub.io: Create beautiful product documentation, hassle-free

#17
post #10

SaaS-ifying your docs seems risky to me. Writing documentation is a big investment and startups tend to come and go ("it's been an incredible journey"). $39/mo is much more than what it costs to self-host Confluence, which for all its flaws at least leaves you in control of your data and is super extensible. Improve the data portability story and it'd be a lot more attractive. Additionally the actual docs and demo si…

Agreed. Had to shutter the docs I had on ReadMe.io when they upped the pricing. Moved to GitBook, then they too upped the pricing. Now I just keep my private docs locally and in a private S3 bucket. Harder for less tech-savy people to edit them, but it's basically free.

I get that these companies need to make money, but $35-40/month is a tough sell for personal projects and the like. I happily pay for GitHub at $7 or $12/month and I wish one of these many companies would offer that pricing tier for docs.

Re: DeveloperHub.io: Create beautiful product documentation, hassle-free

#18
post #14

When I started ReadMe, I tried to buy the domain developerhub.io to use as name... I was inspired by StatusPage.io. But alas, I couldn't get it and went with ReadMe.io instead :) What do you see as the main differentiators of DH compared to ReadMe? (Zaid, feel free to contact me! My email is in my profile)

Oh hey, I recognise your name :) I just want to say thanks for your efforts on swagger-inline! I was actually looking for a tool just like it earlier this year. The project I was using it with was in Python so unfortunately we couldn't justify adding a dependency on Node just for one tool. It did inspire me to write my own similar tool from scratch, compatible with OAS 3.0. Unfortunately it's not open source just yet…

Awesome! I love the idea of keeping the docs right in the code :)

Here's the parent project: http://openap.is/

I don't write code much anymore, but when I do it tends to be non-production stuff like this. (We're a 11-person company!)

Re: DeveloperHub.io: Create beautiful product documentation, hassle-free

#19
post #16

First of all this looks pretty nice. I'm a docs nerd and as a whole I like this. However ... It's slow. Docs should be static HTML. I should not ever wait for text content. If you want to async load some images or embeds that's fine, but I was waiting for the title to load! As an aside I recently had a nice experience making a static docs site using Nuxt and Vue. Nice combination of dynamic development and fast perfo…

I agree with this in principle, except that a good docs library should also have nice full text searching capability. I've yet to see a FT search capability that works nicely with a static doc site.

Re: DeveloperHub.io: Create beautiful product documentation, hassle-free

#20
Seems cool. I'm browsing your own doc and found one thing i hate tho. Could you please please let user himself decide, if he wants to open next pages(your "Next to read") in new browser tab or in the same one? I hate how every second website doesn't respect this.
Post reply on HN