Project

From FVue
Jump to: navigation, search

Processes

Definitions

profile
detect which parts need accelerating

Elements

bug
description of erroneous element which disturbes the project workings
blob fat
the bits/bytes which take up 90% of the project size, but don't contribute to its inner workings. E.g. image, video and music files.
hot
activity
log
information stored to backtrace project activity
src
sourcecode which - compiled or interpreted - direct the main project workings
doc
documentation
rc
run commands. Startup configuration files, like for bash, vim, mutt, etc.
rdb
relational database
stat
statistics of program usage
vendor (thirdparty, 3dparty, 3party)
external libraries

Documentation

  • coding standards
  • caveats, pitfalls, common mistakes
  • communication
  • e-mail
  • examples
  • functional design
  • information
  • considerations, justification, purpose, rationale, why, motivation, Design rationale
  • MRU (Most Recently Used)
  • end-user documentation / manual
  • technical documention
  • generated documention (from source-code)
  • raw
  • wiki

Coding standards

Directory: proj/doc/requirements/codingStandards (link)

Examples:

Layout: rule/why-rationale. Examples:

E-mail

Directory: proj/email.

Internationalization

See also:

Best Practices for XML Internationalization
W3C guidelines

Localization

Make

Directory: proj/

Test

Directory: proj/test.

Tools

Data management

Rotate log files.

Define how data is archived, and ultimately destroyed.

Data encryption.

Types

  • active
  • on_hold

On hold

Of these projects a backup is made less frequently.

Name considerations

Generic-specific or specific-generic?

Often names consist of a generic and a specific part. Should the generic part, or the specific part be named first?

Advantages of naming the generic part first:

  • top-down overview

Advantages of naming the specific part first:

  • tab-completion is more efficient

Philosophies

  • Simplicity
    • KISS-principle (Keep it simple, stupid!)
    • Why to strive for "simple" above "easy": [1]

Comments

blog comments powered by Disqus