A makeover for developer documentation

Starting today, Intuit’s developer documentation has a new landing page. We’ve restructured the docs to make it easier to find information and dev tools.  Click the “Docs & Tools” link on the top left of any of our Intuit Developer pages to check it out. 

What’s happened?

Here’s the problem we’re solving with this reorganization. As we added new content to the old structure, over time the table of contents—the navigation that you see on the left-hand side of the docs pages—became lengthy, complex, and difficult to use.  For example, the QuickBooks Online dev guides for Accounting and Payments were not visible unless you scrolled way down in left-hand navigation. In the tools and SDK documentation and elsewhere, some kinds of information were surfaced in multiple contexts and locations, sometimes only partially, resulting in a user experience where you had to click several times to get the whole story.

While moving around some of the information to make it easier to navigate, we’ve tried to ensure that old links will redirect to the correct page in the new structure. It is possible, though, that some of the links to doc pages you’ve bookmarked might break. We hope that this simplified docs structure will make it easy to find that information. 

What’s the new structure?

Here’s a quick summary of the new structure. 

For each platform, documentation is now organized into the following main sections, represented as tabs on the top of all docs pages:

  • Essentials: How your Intuit Developer account works, and the basics of app creation and maintenance.
  • Dev guides: How to use basic and advanced features of the platform.
  • References: API reference guides.
  • Tools: SDK guides and links to sample apps, sample code, and other tools useful for developing QuickBooks apps. 

Click a link in your platform of choice on the new landing page — https://developer.intuit.com/docs — and check it out. 

Tell us what you think

Let us know what you think in the comments below. We hope you’ll help us continue to improve the documentation and tools pages by giving us feedback and asking questions in the Intuit Developer forum.







3 responses to “A makeover for developer documentation”

  1. Dan Avatar

    Hi Brad –

    if you Google “quickbooks online api”, the first result is for “Docs | QuickBooks API | Intuit Developer” (https://developer.intuit.com/docs/0050_quickbooks_api) which appears to go nowhere. There are a few others on the first results page that do the same thing.

    1. Brad Avatar

      Hi Dan, yes, we noticed that Google is taking some time to re-index our new pages, so your Google searches still return our old pages. We submitted our site to Google for re-indexing, and are also taking other steps to get external searches working right.

  2. George Avatar

    Looks good. You might want to obfuscate the auth credentials in the sample code video.

Leave a Reply

Your email address will not be published. Required fields are marked *