← Digital News

Documentation Update September 4, 2020

Happy September, y’all! The team saw a bout of illness that set us back a bit this month, but we’re caught up and getting back ahead of the game, so let’s go with another Documentation Update!

New Knowledge docs

We picked up a lot of big feature docs from the backlog for August. We continue to update our internal and ops docs as those are in flight, and any newly requested docs are generally completed within a week, if possible.

As for new pages:

And if you’d like to know what’s coming in the next week or so:

  • https://github.com/Banno/knowledge/pull/174 - Forms in Conversations. Alongside this, new docs have been created for the Banno Apps side of Conversations. Both are going through reviews and will be available within the next week or so.
  • https://github.com/Banno/knowledge/pull/169 - In-progress documentation around internal transfers for Silverlake and 2020. This one’s pretty dense and requires a lot of iteration, but should be going live in the next 1-2 weeks. From here, we’ll move onto External Transfers, then we’ll create versions of each doc for other cores.
  • Reorder dashboard - While this isn’t quite in a PR yet, there is a draft of this done and getting reviewed. The External Applications documentation has been completed as a part of this, and both will be going live shortly.
  • Transactions - No PR just yet, but we’ve got some comprehensive docs for the Transactions screens in Banno Apps in progress. These will be in a draft in a PR soon, but as you might imagine, it’s a complex set of docs!

Wiki docs

Our team also helps maintain and update the wiki at docs.banno.com. So far a lot of our workload has come from Operations, with the Resources pages for Content Operations being built up over the last month, including a new document on supporting Banno Marketing.

We’re more than happy to help your team update and maintain wiki docs as well! If you need onboarding materials, documentation for tooling, or more; you can send us a Jira Request any time. While Wiki requests often get a slightly lower priority than those for the Knowledge Base, these are still generally completed within 2 weeks or so. If you’re in doubt as to whether or not we can help out, just make the request! We’ll let you know what we can do and where we need more info.

New Stuff notifications

While we’ll continue to do these updates monthly, those of you interested in what we’re shipping as we ship it will want to keep an eye on #org-documentation in Slack. We’ll be posting each new doc as it ships, and high-profile drafts will be posted in PR format for those that want to weigh in on some of the most important docs we’re pushing out.

If you need your team notified when a requested doc is done, we’ve also got a new field on the documentation request form to add email groups to notify when the doc is live. If your email list isn’t available, just add it to the comments and we’ll make sure it gets added for next time!

No matter what, every new doc will be posted in #org-documentation, so if you want to know everything that’s being shipped, that’s the place to be!

Analytics

For the number nerds, we’ve improved the analytics around the knowledge base to track how many people are using the site. It’ll be a bit before we can share the full stats, but over the last month we’ve seen our daily users nearly double. Please, keep sharing the knowledge base both internally and with customers to help us grow our content and make it useful to everyone!

Anything else?

The scope of what we’ve been working on has increased over the last couple months, with new sections popping up regularly and wiki work kicking up. We’ve got projects in the pipeline to do more architectural work around our various documentation hubs, but in the meantime, our team is available to tackle anything you need written down.

Throw us a service desk request, tag a post with the :documentation-team: reaction, or just give us a holler in #org-documentation! Whether you need new docs, an edit, or have a suggestion as to how we can improve what we’re putting out, we’d love to hear from ya!