documentations currently recommended for MongoDB based applications?

[Kumar]

Hello,

What are the documentations currently recommended for MongoDB based applications?

I belong in the back end database world and traditionally we used to develop following documentation for RDBMS applications.

1. Conceptual Model

2. Logical Model

3. Physical Model

4. Schema definitions

5. Field definitions & examples

Since MongoDB is schemaless it appears 2,3,4 above may not make sense or is not required.

May be we could include 1 and 5 as possible artifacts that could be developed as part of the database team.

Is this reasonable? 

We are an agile shop, are there other artifacts that are recommended that needs to be developed as part of standard documentation ?

thanks.

[Kevin Adistambha]

Hi

What are the documentations currently recommended for MongoDB based applications?

We are an agile shop, are there other artifacts that are recommended that needs to be developed as part of standard documentation ?

This is a very open-ended question, and the answer largely depends on your use case, what do you need the documentations for, and how much time do you want to spend creating and maintaining it. As such, there is no single “standard documentation” for MongoDB applications, since it very much depends on your organization’s best practices.

You outlined five items that you usually document in an RDBMS applications. If this is the documentation style you’re used to, you could probably follow the same structure. As you have already pointed out, some things that needs to be documented in an RDBMS are not applicable to MongoDB, as MongoDB is not as strict as a traditional RDBMS regarding table structure and datatypes. However, I would suggest that you document your indexes and the queries that require those indexes, as indexes are typically tailored to serve specific queries.

On another note, MongoDB 3.2 includes a Document Validation feature if you need a stricter requirements regarding the documents in your collections.

Best regards,
Kevin

​

[Ash N]

Thank you Kevin.

--
You received this message because you are subscribed to the Google Groups "mongodb-user"
group.
 
For other MongoDB technical support options, see: https://docs.mongodb.com/manual/support/
---
You received this message because you are subscribed to a topic in the Google Groups "mongodb-user" group.
To unsubscribe from this topic, visit https://groups.google.com/d/topic/mongodb-user/L_dqL94AZWg/unsubscribe.
To unsubscribe from this group and all its topics, send an email to mongodb-user+unsubscribe@googlegroups.com.
To post to this group, send email to mongod...@googlegroups.com.
Visit this group at https://groups.google.com/group/mongodb-user.
To view this discussion on the web visit https://groups.google.com/d/msgid/mongodb-user/b2f6d898-5289-49d3-9195-4027a2890942%40googlegroups.com.
For more options, visit https://groups.google.com/d/optout.