Bringing Software Development Concepts to Documents

Bringing Software Development Concepts to Documents

Familiar Concepts

We software developers are used to having collaborative tooling. We been using IRC, messaging apps like Slack, deployed wiki’s and much more besides. We’ve been using both centralized and de-centralized version control systems for a long time. We’ve evolved from text editors like Vim/Emacs to fully fledged Integrated Development Environments (IDE) like Eclipse and Visual Studio.

When you leverage such tooling along with refined development processes, software development teams can work on the same codebase without much issue.

But it’s the combination of smarter editing through an IDE coupled with revision control and engineering practices that drives the mission behind Documize.

For developers an IDE + GitHub makes it easier to:

  • Navigate large and complex codebases
  • Visualize the moving parts of a codebase
  • Refactor codebases through reference tracking
  • Jump to definitions, references, usages
  • Save and reuse code libraries, snippets and templates
  • Detect code issues via linting
  • Version control integrations exposting immediate insight into user actions and file amends
  • Troubleshoot problems with debugging aids
  • Kick-start new projects using templates
  • Mark obsolete code as deprecated/TODO
  • Unit testing creating, maintenance and results
  • Code profiling, dead-code detection and elimination
  • Manage change workflows: submit, review, accept, reject
  • Provide feedback on proposed changes via code reviews and annotations
  • Develop and install plugins to enhance the development experience
  • Syntax highlighting for better code comprehension
  • Release management of shipped code into staging and production
  • Source code branching to support parallel working
  • Forking and watching source code repositories for experimentation and monitoring purposes

These IDE features mean:

  • We can refactor and maintain our codebases
  • We can make changes with confidence
  • We can ensure and enforce standards
  • We can reuse content and quick-start new projects
  • We can work as a team, at speed

Which leads us to…

Applied to Documents

The Documize mission is to bring software development inspired features and practices to the world of composing, finding and managing documents.

How much more productive could we all be if we had an Intelligent Document Environment? What would the savings be if we could drastically reduce the tool hops and manual processes associated with documents and documenting?

Here’s is a taste of what the world looks like with Documize:

  • Reusable content libraries to help assemble documents quicker using best practices
  • Lint content for readibility, grammer and other improvements
  • Instant jump to spaces, documents, content
  • Setting read-points that show additional contextual information at specific points within documents (linking, prompting)
  • Show references by detailing inbound/outbound links
  • Contribution management, suggest, request, review, accept, reject
  • Jump-start new documents from templates
  • Jump-start new documents by selecting a “type” – contract, notes, spec, guide
  • Track unread documents and content
  • Baseline, lock document versions
  • Mark and manage document TODO/FIXME issues
  • Document approvals before publication
  • Monitoring spaces and documents for additions, deletions and changes
  • Archiving obsolete documents
  • Linking related documents

..and plenty more besides.

Documize is built to power the enterprise-wide knowledge backbone – how we find, share, and capture knowledge in a world of information overflow.