Welcome to XDA

Search to go directly to your device's forum

Register an account

Unlock full posting privileges

Ask a question

No registration required
Thread Closed

[Development type][Project type][Version - Date] A Project template for XDA

OP Developer Committee

6th May 2013, 07:46 PM   |  #1  
OP Committee Leader
Thanks Meter: 109
 
1,462 posts
Join Date:Joined: Mar 2011
Code:
*** Disclaimer

This is the logical place to tell users about behaving responsibly and 
thermonuclear war.

Introduction
Quote:

This template can be used to create clear threads with only the minimum of required information directly available and a unified look users easy to understand for your users. Information section should be used for background information about your projects. Introductions, how did the project come into existence, what problem does it solve, the background information needed to understand the project are logical pieces of information to put in the introduction section.



Images
Quote:

Next up are screenshots, pictures, and designs of the projects. If you have smaller images put multiple on the same line like this:



Or f you have a very large image or many smaller ones:


Hide (part of) them by using the HIDE and /HIDE tags:



Features
Quote:

If applicable, add a comprehensive list of the main features of your project. Make sure to keep that list compact and only list the most important/outstanding points.

  • Avoid meaningless terms
  • Always use short points
  • etc



Installation instructions
Quote:

In this section tell your users about possible prerequisites for getting your project to work. Then give a simple guide of steps to follow to for the installation process. If possible use a list:
* Copy this thread and the vB tags
* Follow the steps in this thread
* Write down information on your project
* Publish thread



Changelog
Quote:

Only directly show your latest changelog. Some projects get quite long and your users will get "the scrolls" after a while. Put the individual changelogs in CODE and /CODE tags if you can. If you need to link from your changelogs to other pages or threads use the QUOTE and /QUOTE tags instead. The CODE and /CODE tags have a finite length so try to keep it brief enough for each line to fit or make sure you cut the line off by using enter/returns. Please if you use a stock parts (kernel etc.), explicitly state so.

Code:
Current changelog: 11-11-2012
[note] Your changelogs should have tags as well.
[new] The new tag describes a new function in your project.
[changed] The changed tag describes a function that was changed in
          this update.
[fixed] Describe the major bugs that were fixed here.
Older changelogs should be hidden from direct view:

Code:
Changelog: 11-11-2011
[note] Your changelogs should have tags as well.
[new] The new tag describes a new function in your project.
[changed] The changed tag describes a function that was changed in
          this update.
[fixed] Describe the major bugs that were fixed here.
Code:
Changelog: 11-11-2010
[note] Your changelogs should have tags as well.
[new] The new tag describes a new function in your project.
[changed] The changed tag describes a function that was changed in
          this update.
[fixed] Describe the major bugs that were fixed here.
Code:
Changelog: 11-11-2009
[note] Your changelogs should have tags as well.
[new] The new tag describes a new function in your project.
[changed] The changed tag describes a function that was changed in
          this update.
[fixed] Describe the major bugs that were fixed here.



Downloads
Quote:

Finally the place where the magic happens, the download section! Provide your users with download instruction and link(s). If you can provide a checksum here so users can verify that the download was successful. Also of you want to or need to share your projects sources. This is the place to do that too. Please if you use a stock parts (kernel etc.), explicitly state so.

Download
Project Template

Sources
Project Template



Addons/Themes/User Art
Quote:

Addons
Use hide if the list grows longer that 3 items.

Themes
Use hide if the list grows longer that 3 items.

User Art
Use hide if the list grows longer that 3 items.



FAQ
Quote:

The FAQ section in a thread is bound to grow over time, but it may be small to start with, so whether or not you you should hide part of this section is up to you, but you will likely need the most urgent questions in direct view. If questions are short and the answer tends to be long you may choose to hide the answers but not the questions.

Q: DO'S
A: Use normal sized text for any paragraph of texts
A: Paragraphs of text should be black, no exceptions
A: Images are nice, but keep them proportional to your text
A: Use a title -> paragraph stucture, a short and clear title (a subtitle if needed) and put information in the paragraph
A: Use ROM, APP, MOD, TOOL, THEME and GUIDE tags in the development tags in the thread title
A: Use CM9, AOKP, STOCK etc. to describe the project type in the thread title

Q: DON'TS
A: Don't use big font's, unless you use them to create titles.
A: Don't center your text, this breaks the reading flow

Q: Should I put this entire thread one one page or is it okay to distribute it across multiple pages?


A: Whether or you put your project on page or on multiple is entirely up to you, just make sure it feels consistent across all pages.


Q: I have my own thread design, can I use that?

A: Sure thing! But remember consistency is key here, make sure you take away the good things from the template and respect the do's and don't.



Thanks To/Credits
Code:
* Hero's
* Contributors
* Mentors
* Testers
* Donators
Last edited by kinfauns; 23rd October 2013 at 05:33 AM.
The Following 85 Users Say Thank You to Developer Committee For This Useful Post: [ View ]
Thread Closed Subscribe to Thread
Previous Thread Next Thread
Thread Tools Search this Thread
Search this Thread:

Advanced Search
Display Modes