Closed. This question is opinion-based. It is not currently accepting answers.
Want to improve this question? Update the question so it can be answered with facts and citations by editing this post.
Closed 5 years ago.
Improve this question
I am developing a database that organizes scientific data from my group and diverse experiments reported in the literature, (my background is in science rather than project management or programming).
I currently have three documentation documents for:
end users of data
data enter-ers
developers (e.g. myself and my successor)
Other than following the users guides and descriptions from other databases, are there any best-practices I should follow, perhaps a latex template, or a mysqldump option that will automatically do some of the documentation?
Doxygen supports SQL. I would export the DDL SQL statements, document them with Doxygen notation and export it to HTML / PDF / whatever.
I wish there were a standard solution, but industry practice is ad hoc at best.
In MySQL, be sure to fill in the comment fields when creating tables and fields. If you use MySQL administrator, it makes it easy to manage, but that's most useful for developers to directly use. It can be used as the basis for expansion for the other categories of readers.
Related
Closed. This question is opinion-based. It is not currently accepting answers.
Want to improve this question? Update the question so it can be answered with facts and citations by editing this post.
Closed 4 years ago.
Improve this question
I'm building an application with the instant messaging functionality.
The application will allow the users to send files/images as well as normal text messages.
I decided to take the approach with storing the files on the filesystem and write only the file paths to the database. There will be no updates to the files (only insertions and deletions).
Which database would be the best for storing a large amount of file paths, that would be easy to query for a certain user files?
I would go with MongoDB. My experience is that a document based approach using a single Messages collection would be best. Each message document then contains all of the file paths. This eliminates joins and better supports potential future functional requirements changes.
MongoDB also provides great ways to deal with old messages such as TTL indexes.
Closed. This question is opinion-based. It is not currently accepting answers.
Want to improve this question? Update the question so it can be answered with facts and citations by editing this post.
Closed 8 years ago.
Improve this question
I have CSV File's With Different Columns With Few Common Columns, We Are Currently Using Excel To Remove Unwanted Rows Clean The Data, and Generate Reports, I Am Thinking Of Using Elasticsearch As A Solution For Data Storage, Transformation, Load And Reporting.
Is Elasticsearch A Good Choice For This Use Case ?
Elastic Search is, as the name indicated, using to quick search. It is build upon Lucene and similar to another Apache project, Solr...
If you want to query the raw data or do some simple aggregation upon it. It is fine and you can also use Kibana to come up with some fancy GUI so your audience can interact with the data and you can even come up with some dashboard to demonstrate some basic staff. However, it is not a replacement of a data base.
If you want to update or join.. you had better use some data base ... sql + mongo or hive for big data.
Closed. This question needs to be more focused. It is not currently accepting answers.
Want to improve this question? Update the question so it focuses on one problem only by editing this post.
Closed 8 years ago.
Improve this question
I'm writing documentation for my AQA A-level Computing project. The project is a game which takes place in a Console application, which heavily depends on a series of classes and structures in a separate class library I have written. I don't know how to title the section in my documentation where I describe these classes and structures, and I'd like to know if there is a word that encompasses both concepts. Does the word "record" include both classes and structures, or is it tied to a specific implementation?
I'm aware that this is more English Language & Usage, but I thought it was more likely to get a response here where there are more programmers.
Yes, you could use the term record as objects/classes/structures are just differing types of records, or records with functions to handle the data in the record.
However, just to encapsulate all your possibilities, you should probably utilize the term Data Structure. I find that data structure is more common parlance than record.
Closed. This question is opinion-based. It is not currently accepting answers.
Want to improve this question? Update the question so it can be answered with facts and citations by editing this post.
Closed 5 years ago.
Improve this question
I've been developing a small database for my summer internship and I need to write a manual/documentation for it aimed at both users and developers for future use. Thing is...I have no idea where to start or what information to include. Many people I work with have no idea what databases can do so I need to keep it as simple as possible. The database is implemented in Access and I experimented with the database documenter but I think that is overkill. Is there some kind of documentation standard that I can follow or anything of that nature?
As a starter for ten, I'd have thought that the user documentation should be task orientated.
(i.e: How to achieve 'X'.)
In terms of the developer documentation, defining the meaning of any non-obvious fields in your schemas, how they're used and the relationships between different tables, etc. would be a good start. (I'm presuming your VBA code is well commented, etc.) You may also want to examine the existing "Documenting Visual Basic with Doxygen" question/answer.
Just straightforward english if you are explaining a process.
If you have a series of Macros do a document highlighting to code used in each macro and the order it should be employed. This could aid someone down the line if they are trying to automate the process.
Closed. This question is opinion-based. It is not currently accepting answers.
Want to improve this question? Update the question so it can be answered with facts and citations by editing this post.
Closed 8 years ago.
Improve this question
I've been told that I should include PAD files with the freeware applications I distribute so hosting sites can list the information correctly and check for updates, etc.
Can you give me some info on using PAD files? Here are general questions which come to mind:
Is it worth the effort?
Do you use PADGen or an online tool like www.padbuilder.com?
Do you digitally sign yours?
I do use padgen, it does not take too long to make a pad file, but what takes time is submitting it... just copy+paste stuff from your marketing material into it.
keep storing all your pad files on your webserver and new version updates are listed in 1000+ small shareware/software sites automatically. however, download amounts from these sites are usually < 1000/mo.
not signed mine.