Sharing Collection

DevScribe Collections bring related project resources together so they can be organized and shared as a single collection.

What Is a DevScribe Collection?

A collection is a way to group the different resources that belong to a project in one place.

Instead of treating every document, API request, diagram, or code file as a separate item, you can organize them together as part of the same collection.

Depending on the project, a collection can include:

• Documents
• API requests
• Database queries
• Code files
• JSON payloads
• Diagrams
• Terminal sessions
• Docker configurations

For example, a collection for an e-commerce application could contain its project documentation, HLD diagram, API requests, database queries, and relevant code files.

Why Use Collections?

The useful part of a collection is simple: the resources stay together.

Consider a project handoff. You may need to share:

• the architecture of the application
• API requests used for testing
• database queries
• setup documentation
• code or configuration files

Sending each resource separately means keeping track of several files and making sure nothing is missed.

A collection packages these related resources together, making the project easier to share as a unit.

A Collection as a Project Workspace

A collection can represent the technical resources for a particular application, feature, or prototype.

For example, a QuickCart collection could look like this:

Documentation: Project overview and setup instructions

Architecture: HLD diagram

API: API requests

Database: Database queries and schema information

Code: Relevant code files

The collection keeps these resources associated with the same project instead of treating them as unrelated files.

Sharing a Collection

Once a collection is organized, it can be exported and shared with another DevScribe user.

DevScribe uses the .dscollection format for collections.

The exported collection can then be imported into DevScribe, allowing the recipient to work with the resources included in it.

This is useful for project handoffs, onboarding, collaboration, and sharing example projects without having to transfer each resource individually.

When to Use a Collection

Collections can be useful when you want to:

• Share a complete project workspace
• Onboard another developer
• Hand off technical work
• Package documentation with supporting resources
• Move a project between DevScribe installations
• Share a prototype or example project

The idea is straightforward: if several DevScribe resources belong to the same piece of work, they can belong in the same collection.

Conclusion

DevScribe Collections provide a simple way to organize related project resources and share them as a single package.

Documentation, diagrams, API requests, database queries, code, and other resources can be brought together under the same collection instead of being shared individually.

When the collection is ready, export it as a .dscollection file and share it with another DevScribe user.

The next step is actually using one: exporting and importing a DevScribe Collection.