Corilla User Guide
Introducing the Corilla beta

Introducing the Corilla beta

Hello world. This is the first public beta release for Corilla. Our mission is to make technical writing awesome, and we would love to hear your thoughts on our first release.

In our first public beta, we've built a blazing fast workflow to help technical writers author, manage and collaborate on documentation across teams and at scale. We even provide real-time preview and HTML publishing to our secure servers.

A note on our mission and company culture

Corilla is built with our experience as technical writers and in content teams for major software companies. But more importantly it is built as writers who love to write, coders that love to code, and designers who love to design in the fields of content and communication science.

Our love for our sector isn't matched by many organisations. Too often, technical writers are forced to use tools that they hate to create content that customers are no longer reading.

Corilla was born of solving this problem in a major open source software company first. Our history spinning out and launching our own technical writing startup is documented in our manifesto.

While currently in draft, our manifesto showcases our bias that there is no more important time in human history to develop and nurture our communication and knowledge sharing skills. It also highlights our culture of learning, determination, curiousity and gratitude (among others) that we hope to share with you in this beta release and beyond.

The writing and publishing workflow

The general workflow revolves around the following key requirements:

  • write a topic using Corilla's blazing fast Markdown editor
  • have immediate feedback on Markdown rendering with syntax highlighting
  • save the topic with Corilla's inbuilt version control system
  • graphically navigate and group topics as a collection
  • graphically reorder and arrange topics
  • preview collections in realtime
  • publish directly to HTML with full version control

For our beta release, our priority was on building out the basic end-to-end experience of creating and publishing a collection of topics. All in one environment.

The following video on our writing and publishing workflow summarises the general direction of Corilla.

alt text

There's a lot we are working on in weekly sprint cycles. If you would like to join us in making technical writing awesome, we are always welcoming new members of our developer and content community. And we are also hiring.

Understanding topics and collections

TBC

Introducing collections

Introducing collections

Hello world, we're working on this one. If you would like this topic to be prioritised, just let us know.

Create and manage collections

Create and manage collections

Hello world, we're working on this one. If you would like this topic to be prioritised, just let us know.

Introducing topics

Introducing topics

Topics are the basic content types in Corilla. You can use topics as an atomic piece of content or as a full and featured document. It's your content after all!

We recommend using topics to document one specific task a user might require. This is a loose and accommodating interpretation of both the topic-based authoring and DITA models of technical writing.

Caution: DITA and topic-based authoring are contentious technical writing concepts and likely to result in flame wars. Approach topics with caution. When in doubt, drop a pile of Moleskin pads to distract and run.

Corilla looks at topics as simply a logical container that best fits the content needs of the modern web. They are the lego bricks of our information age.

Examples of specific topics:

  • Deploy a server with Awesome Application Server 1.0
  • Quickstart guide to working with Awesome Application Server 1.0
  • Manage remote teams with the admin console
  • Import mailing lists with Monkey Product
  • Ten reasons to tell everyone to use Corilla

The following video describes Corilla's use of topics and the Markdown editor.

alt text

Publishing collections in Corilla

Publishing collections in Corilla

Hello world, we're working on this one. If you would like this topic to be prioritised, just let us know.

Mastering the Corilla end-to-end workflow

Mastering the Corilla end-to-end workflow

Hello world, we're working on this one. If you would like this topic to be prioritised, just let us know.

About the editing workflow in Corilla

About the editing workflow in Corilla

Hello world, we're working on this one. If you would like this topic to be prioritised, just let us know.

Create and edit topics

Create and edit topics in Corilla

Create topics

Create a new topic by clicking on the New Topic button. Enter a descriptive title.

We recommend thinking of the context of your title with your other topics in your content suite. Also be mindful of the impact of your content's discoverability online.

alt text

But don't worry, you can change a title anytime in the topic view mode.

Writing and editing topics

The Corilla editor is a blazing fast implementation of the Markdown syntax.

Markdown is a lightweight markup language created by John Gruber and Aaron Schwartz in 2004. We've created a cheat sheet for new users to learn this easy syntax.

Titles

In our beta version, topic titles are changed for internal views by clicking on the topic title name directly in the top left of the editing pane. To change the published title, simply change the

About tags and filters in Corilla

About tags and filters in Corilla

Hello world, we're working on this one. If you would like this topic to be prioritised, just let us know.

Manage media files in Corilla

Manage media files in Corilla

Hello world, we're working on this one. If you would like this topic to be prioritised, just let us know.

About team management in Corilla

About team management in Corilla

Hello world, we're working on this one. If you would like this topic to be prioritised, just let us know.