Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Create FAQ for MDF #84

Open
Neumann-A opened this issue Aug 24, 2017 · 6 comments
Open

Create FAQ for MDF #84

Neumann-A opened this issue Aug 24, 2017 · 6 comments

Comments

@Neumann-A
Copy link
Contributor

As mentioned in #74 it might be a good idea to create a FAQ for MDF

with general questions like (some questions might already be answered by the spec but in a FAQ you also want those):

  • What is MDF meant for?
  • Why have MDF?
  • Why use MDF? What advantages does MDF offer?

and more technical questions like:

  • What does MDF consider an image?
  • What does MDF consider an patch/frame?
  • When is a patch a frame? When is a frame a new file? etc.
  • My data is acquired as J x N x C x W how to handle it in MDFs N x J x C x W storage order?
  • Why is group/dataset XYZ in the MDF?

feel free to add more questions and maybe also the answers.

@hofmannmartin
Copy link
Member

I like the idea of including a FAQ section 👍

@tknopp
Copy link
Member

tknopp commented Aug 24, 2017

with general questions like (some questions might already be answered by the spec but in a FAQ you also want those):

What is MDF meant for?
Why have MDF?
Why use MDF? What advantages does MDF offer?

If you are not satisfied with our introduction. Please improve it !!! Also please improve the Readme.md if you feel that these things are not answered.

@tknopp
Copy link
Member

tknopp commented Aug 24, 2017

What does MDF consider an image?
What does MDF consider an patch/frame?
When is a patch a frame? When is a frame a new file? etc.
My data is acquired as J x N x C x W how to handle it in MDFs N x J x C x W storage order?
Why is group/dataset XYZ in the MDF?

All this should not be an FAQ. It should be explained in the specification.

@Neumann-A
Copy link
Contributor Author

If you are not satisfied with our introduction. Please improve it !!!

The questions was not meant as criticism more like a general example of questions which would be included in a FAQ.

All this should not be an FAQ. It should be explained in the specification.

No and Yes. The whole idea of having a FAQ is to have fast access to some commonly asked or more complex questions (which are not easy to answer purely by the specification). The FAQ can also reference the specification with side and line number.

@tknopp
Copy link
Member

tknopp commented Aug 24, 2017

I am not against a dedicated FAQ. But lets please not explain things twice. Half of your questions above belong to the specification.

@Neumann-A
Copy link
Contributor Author

I am not against a dedicated FAQ. But lets please not explain things twice. Half of your questions above belong to the specification.

Just an example:
Somequestion?
Answer: This question is directly answered in the specification. Please see side X line Y (or even better have a html version of the spec and directly link it)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

3 participants