Improving the state of the art in API documentation sites

A “community” site for presenting NuGet packages documentation on a modern, serchable and commentable way: Improving the state of the art in API documentation sites – Daniel Cazzulino’s Blog.

I can see immediate benefits : easy searchability. But to improve documentation, either this site must becomes the only way to provide documentation or community comments must be placed into a virtuous circle and must be re injectable into initial doc.

There is a mechanism to download separatly each package locally to be able to use same doc offline. But it requires to start an IIS Express for each documentation downloaded. So we have to open a http://localhost:random_port/ for each doc. Not very usable for now bur I have no doubt that process will be improve in next version.

A promising start: wait and see.

Leave a Reply

Fill in your details below or click an icon to log in:

WordPress.com Logo

You are commenting using your WordPress.com account. Log Out /  Change )

Twitter picture

You are commenting using your Twitter account. Log Out /  Change )

Facebook photo

You are commenting using your Facebook account. Log Out /  Change )

Connecting to %s