DEV Community

Cover image for DevScribe currently puts your project docs in ONE file. Should I split it up?
DevScribe
DevScribe

Posted on

DevScribe currently puts your project docs in ONE file. Should I split it up?

DevScribe currently puts your entire project docs in ONE file. Should I split it up?

Quick context: I built DevScribe - an all-in-one offline desktop app that combines docs, system design, API testing, database tools, and code execution in a single workspace.

Right now it creates a single document with:

Project Documentation

Think of it as Notion + Draw.io + MySQL Workbench + Replit + Postman all in one document. No more switching between 5 different tools to document your project.

System Architecture

DevScribe system architecture diagram showing visual design tools and component relationships

API Documentation

DevScribe API documentation interface with endpoint testing and request/response examples

Database Schema

DevScribe database ERD viewer showing table relationships and schema visualization

Common Queries

DevScribe SQL query editor with executable queries and results panel

Code Snippets

[Runnable Java/JS/TS/SQL/Shell code]

DevScribe code execution environment supporting Java, JavaScript, TypeScript, SQL, and Shell scripts

But some users are asking for separate files:

/docs
  ├── architecture.md
  ├── api-docs.md
  ├── database.sql
  └── queries.sql
Enter fullscreen mode Exit fullscreen mode

The debate:

  • Team A: "One file = one source of truth. Love it!"
  • Team B: "Separate files = better git workflow"
  • Team C: "Why not both? Make it configurable"

I'm considering this for v2. What would work better for your workflow and why?

Currently leaning toward making it configurable, but wondering if that's overengineering it.

Share your documentation structure preferences below! 👇
P.S. If you want to see it in action: https://devscribe.app

Top comments (0)