Getting Started with Devscribe

DevScribe is an all-in-one workspace for software engineers, architects, and technical teams.

It brings documentation, diagrams, APIs, databases, JSON, code, terminal commands, Docker configurations, and other development resources into one workspace.

Instead of keeping project information across several tools, you can organize the resources you need in DevScribe and keep them together as part of the same project.

What Can You Do in DevScribe?

DevScribe includes tools for common development and documentation workflows.

• Documentation
• Architecture and system diagrams
• API testing
• Database queries and resources
• JSON editing and comparison
• Code and scripts
• Terminal commands
• Docker Compose
• GitHub integration
• External plugins

Each section of the documentation covers these features in more detail, with examples and practical workflows.

Why DevScribe?

A project usually involves more than source code.

Documentation may be stored separately from architecture diagrams. API requests may live in an API client, while database queries, useful commands, JSON payloads, and code snippets are saved somewhere else.

This makes it difficult to keep track of the context around a project.

DevScribe brings these resources into the same workspace.

Documentation

Write technical documentation, project notes, setup instructions, and other development-related content.

You can also include other DevScribe resources within your documentation, so the information and the tools used to work with it can stay together.

Diagrams

Create architecture and system diagrams, including HLD, LLD, ERD, UML, sequence diagrams, and flowcharts.

Diagrams can be used alongside project documentation to explain how different parts of a system fit together.

APIs

Create and test API requests and keep them alongside the documentation and other resources for the project.

DevScribe supports common API workflows including REST APIs and other supported protocols.

Databases

Work with database connections, tables, schemas, and queries without keeping database-related information separate from the rest of your project.

JSON

Create, edit, format, and compare JSON payloads.

This is useful for working with API requests and responses, configuration data, and example payloads.

Code

Keep code snippets, scripts, examples, and development exercises in the same workspace as the resources they relate to.

Terminal

Save and work with terminal commands without having to search through shell history whenever you need them again.

Docker

Keep Docker Compose configurations and related setup information with the rest of the project.

GitHub Integration

Connect your development workflow with GitHub and keep relevant project resources together.

External Plugins

Extend DevScribe with plugins when you need functionality beyond the built-in tools.

Documentation That Includes Your Tools

DevScribe documentation is not limited to text.

A project document can include the resources that support the information being explained.

For example, documentation for an application could contain:

• An HLD diagram describing the architecture
• API requests for testing endpoints
• Database queries used by the application
• JSON payloads for API examples
• Code snippets showing an implementation
• Terminal commands for setting up the project
• Docker configurations for running services

This keeps the explanation and the resources behind it in the same workspace.

Keep Project Resources Together

A project can have many moving parts. Keeping them together makes it easier to find the information you need later.

For example, a project workspace could contain:

Project Documentation: Technical overview, setup instructions, and project notes.

Architecture: HLD, LLD, ERD, or other system diagrams.

API: Requests used to test and document the application.

Database: Queries, tables, and schema information.

Code: Relevant files, snippets, and examples.

Setup: Terminal commands and Docker configurations.

When these resources need to be shared, they can also be organized into a DevScribe Collection and exported as a collection.

What Can You Use DevScribe For?

DevScribe can be used for different stages of development and technical work.

You can use it to:

• Document an existing application
• Create architecture documentation
• Test and organize APIs
• Work with databases and queries
• Keep reusable code snippets
• Store technical references
• Prepare project handoffs
• Onboard developers
• Practice DSA and database concepts
• Build a personal engineering workspace
• Organize project resources into shareable collections

Explore the Documentation

Start with the section that matches what you want to do.

Document Plugin
Learn how to create documentation and work with different types of embedded resources.

Architecture Diagram Tool
Create HLD, LLD, ERD, UML, sequence, and other system diagrams.

API Doc Tool
Create and organize API documentation.

Database Doc Tool
Document database structures, connections, and queries.

Code Editor
Write and organize code snippets and development exercises.

GitHub Integration
Work with GitHub as part of your development workflow.

External Plugins
Add plugins and extend DevScribe with additional functionality.

Sharing Collections
Organize related project resources and share them as a collection.

Getting Started

DevScribe brings the tools and information around a project into one workspace.

You can start with a document, build an architecture diagram, test an API, connect to a database, save some useful commands, or organize an existing project into a collection.

From there, the different resources can stay together as the project grows.