fishy icon indicating copy to clipboard operation
fishy copied to clipboard

Documentation: Extend and add multiple sections

Open importantchoice opened this issue 7 years ago • 1 comments

We need to add some sections to the documentation:

  • ~~Why we wrote this tool, why should our program be used, analysis of existing tools...~~

  • ~~Use case of our tool~~

    • ~~Maybe just describing a brief scenario where one could use this tool~~
    • ~~Mention that no encryption is applied to the hidden data, so the user is responsible for that.~~
  • ~~Document create_testfs.sh including testfs filestructure (the reason/test case for each file/directory)~~

  • ~~Limitations of our program (e.g. linux only)~~

  • Evaluation of our program and hiding techniques

    • Gained Capacity for each hiding technique
    • Detection Rate with fsck and forensic analysis tools
    • stability of the hiding technique
  • ~~Extended usage, e.g. use pipes to add checksumming and encryption~~

  • ~~Metadata: explicitly mention that it is serialized as json~~

  • Filesystem data structures for ntfs ~~and ext4~~

  • Hiding Technique documentation (nearly all)

  • ~~List all implemented hiding techiques in README.md AND doc/source/01_getting_started.rst~~

  • Api Reference for nearly all important modules

  • ~~Development: move notes from readme to documentation and extend it~~

  • ~~Future work (-> turn following bullet points into continuous text!)~~

    • ~~Use a more secure clearing technique for hiding techniques -c option~~
    • ~~Add possibility to hide multiple files~~
    • ~~Implement a fuse filesystem, which uses multiple hiding techniques to store data~~
    • ~~Maybe add encryption feature~~
    • ~~Hide Metadata files itself~~
    • ~~more reliable filesystem autodetection (FAT and NTFS detection only check for an ASCII string in bootsector)~~
  • Extend "abstract"

  • ~~include documentation structure (01_overview.rst)~~

  • Turn most bullet points into text

  • ~~Make sphinx size included images to a format that fits on page for the pdf version.~~

  • For all:

    • Please check all written stuff for consistency. Many eyes see more than just ~~one~~ two.
    • ~~Add your name to the author variable in fishy/doc/source/conf.py (if you want), so that it will appear on the documentation.~~
    • Check if all of your work is mentioned in responsibilities (doc/source/07.2_responsibilities.rst)

importantchoice avatar Dec 14 '17 08:12 importantchoice